empty readme for now

git-svn-id: https://test-tap.googlecode.com/svn/trunk@9 62346678-a08d-11dd-9c66-c9f8973bfffa
This commit is contained in:
Jeremy@marzhillstudios.com 2008-12-28 03:09:41 +00:00
parent 90966cab7d
commit 5fe4f09d38

57
README
View File

@ -1,57 +0,0 @@
NAME
JSAN.Example - Example Library for the JavaScript Archive Network
SYNOPSIS
// Functional Example
JSAN.Example.functionOne([
'do', 'stuff', 'with',
'this', 'example'
]);
// Class Example
var ex = new JSAN.Example;
ex.useMeHere();
// JSAN Example
var jsan = new JSAN;
jsan.use('JSAN.Example');
var ex = new JSAN.Example;
ex.useMeHere();
DESCRIPTION
This library is really lame. Please update the docs.
Constructor
var ex = new JSAN.Example();
Create a new "JSAN.Example" object.
Class Properties
DEBUG
JSAN.Example.DEBUG = 11; // This one goes...
blah blah
Methods
useMeHere()
ex.useMeHere();
blah blah
EXPORTS
When used with "JSAN" this will export "functionOne" and "functionTwo"
by default.
SEE ALSO
"JSAN"
AUTHOR
A. Thor <user@example.com>
COPYRIGHT
Copyright (c) 2005 A. Thor. All rights reserved.
This module is free software; you can redistribute it and/or modify it
under the terms of the Artistic license. Or whatever license I choose,
which I will do instead of keeping this documentation like it is.