geoff
/
record.js
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

readme tweaks

This commit is contained in:
Geoff Doty 2018-05-06 19:09:47 -04:00
parent 654e39b9a1
commit f84aa6ae45
1 changed files with 7 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -2,16 +2,16 @@
> A minimalistic object collection library > A minimalistic object collection library
**Record.js** aims to provide a lite, *2kb*, *zero-dependency* collection utility to help build simple in-memory or local storage database of records. Records are stored as simple arrays. **Record.js** aims to provide a lite, *2kb*, *zero-dependency* collection utility to help build simple in-memory or local storage database of records. Records are stored as plain arrays.
Records can be exported to JSON, with no internals so you can import your data anywhere; via `.dump()` Records can be exported to JSON, with no internal metadata[*], so you can import your data anywhere; via `.dump()`
### Features ### Features
- Tiny, only 2kb - Tiny, only 2kb
- Zero-Dependencies - Zero-Dependencies
- Saves to LocalStorage (if available) - Saves to LocalStorage (if available)
- Saves to simple JSON - Data saved as simple JSON
- Browser or Nodejs compatible - Browser or Nodejs compatible
## Getting Started ## Getting Started
@ -94,3 +94,7 @@ Anyone is welcome to contribute, however, if you decide to get involved, please
## License ## License
[MIT](LICENSE) [MIT](LICENSE)
---
> [*]: with exception of a generated ID, if not provided