Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
jio
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
0
Merge Requests
0
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
Stefane Fermigier
jio
Commits
f769b55a
Commit
f769b55a
authored
Apr 12, 2013
by
Tristan Cavelier
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
fix markdown typo
parent
4d3905b5
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
6 additions
and
6 deletions
+6
-6
README.md
README.md
+6
-6
No files found.
README.md
View file @
f769b55a
# Javascript Input/Output
#
#
Javascript Input/Output
**
jIO is a client-side JavaScript library to manage documents across multiple
**
jIO is a client-side JavaScript library to manage documents across multiple
storages.
**
storages.
**
## Getting Started
##
#
Getting Started
To set up jIO include jio.js, dependencies and the connectors for the storages
To set up jIO include jio.js, dependencies and the connectors for the storages
you want to use in your page header (note that more dependencies may be required
you want to use in your page header (note that more dependencies may be required
...
@@ -26,7 +26,7 @@ Then create your jIO instance like this:
...
@@ -26,7 +26,7 @@ Then create your jIO instance like this:
"application_name": "your_application_name"
"application_name": "your_application_name"
});
});
## Documents and Methods
##
#
Documents and Methods
Documents are JSON strings that contain _meta-data_ (properties, like a filename)
Documents are JSON strings that contain _meta-data_ (properties, like a filename)
and _attachments_ (optional content, for example a base64 encoded image).
and _attachments_ (optional content, for example a base64 encoded image).
...
@@ -101,7 +101,7 @@ each method, please refer to the documentation):
...
@@ -101,7 +101,7 @@ each method, please refer to the documentation):
// }
// }
});
});
## Example
##
#
Example
This is an example of how to store a video file with one attachment in local
This is an example of how to store a video file with one attachment in local
storage . Note that attachments should best be added inside one of the available
storage . Note that attachments should best be added inside one of the available
...
@@ -139,7 +139,7 @@ document callback methods (success & error or callback)
...
@@ -139,7 +139,7 @@ document callback methods (success & error or callback)
}
}
});
});
## Storage Locations
##
#
Storage Locations
jIO allows to build "storage trees" consisting of connectors to multiple
jIO allows to build "storage trees" consisting of connectors to multiple
storages (webDav, xWiki, S3, localStorage) and use type-storages to add features
storages (webDav, xWiki, S3, localStorage) and use type-storages to add features
...
@@ -248,7 +248,7 @@ Replicate Revision Storage (replicate documents across multiple storages)
...
@@ -248,7 +248,7 @@ Replicate Revision Storage (replicate documents across multiple storages)
For more information on the specific storages including guidelines on how to create your own connector, please also refer to the documentation.
For more information on the specific storages including guidelines on how to create your own connector, please also refer to the documentation.
## Complex Queries
##
#
Complex Queries
jIO includes a complex-queries manager, which can be run on top of the allDocs()
jIO includes a complex-queries manager, which can be run on top of the allDocs()
method to query documents in the storage tree. A sample query would look like
method to query documents in the storage tree. A sample query would look like
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment