From 0c11b4af7f83f0ac9e8529fd89704bb04db034e2 Mon Sep 17 00:00:00 2001 From: Geoff Doty Date: Wed, 6 Jun 2018 08:12:03 -0400 Subject: [PATCH] readme why --- README.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index b242590..716b2d9 100644 --- a/README.md +++ b/README.md @@ -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 \ No newline at end of file +> [*]: with exception of a generated ID, if not provided