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

readme why

This commit is contained in:
Geoff Doty 2018-06-06 08:12:03 -04:00
parent f84aa6ae45
commit 0c11b4af7f
1 changed files with 6 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -11,9 +11,13 @@ Records can be exported to JSON, with no internal metadata[*], so you can import
- Tiny, only 2kb
- Zero-Dependencies
- Saves to LocalStorage (if available)
- Data saved as simple JSON
- Data saved, and exported as simple JSON
- Browser or Nodejs compatible
### Why
Sometimes having a simple single-user data storage library that stays out of your way while you prototype out your ideas is all you need. With a small footprint, removing/replacing a library like `record.js` is a breeze. Ideally, using this to library to build out configuration files, mock out test data, or even develop simple applications is where this shines. I use it for just that! I often replace this library once an idea becomes soluble; I export the data to JSON to a real DB and expand.
## Getting Started
- [Download Library](https://raw.githubusercontent.com/n2geoff/record.js/master/dist/record.min.js), then...
@ -97,4 +101,4 @@ Anyone is welcome to contribute, however, if you decide to get involved, please
---
> [*]: with exception of a generated ID, if not provided
> [*]: with exception of a generated ID, if not provided