Verified Commit c4158cdd authored by Aral Balkan's avatar Aral Balkan
Browse files

Update readme

parent ab2a4bba
......@@ -20,24 +20,11 @@ __Needless to say, this is not ready for use yet. But feel free to take a look a
- [x] ╰─ Document queries. (1 Oct)
- [x] __Bring code coverage back up to 100%.__ (2 Oct)
- [x] __Implement safety controls on instantiation and table replacement.__ (5 Oct)
- [x] __Implement JSDF serialiser__ (inc. support for custom objects, and Date, etc.) (12 Oct)
- [x] __Implement JSDF serialiser__ (inc. support for custom objects, and Date, etc.) (16 Oct)
- [ ] __Integrate into [Site.js](https://sitejs.org)__ _(in progress)_
- [ ] __Use/test on upcoming small-web.org site__
- [ ] __Release version 1.0.0__
## Ideas for post 1.0.0.
- [ ] __Implement [transactions](https://github.com/small-tech/jsdb/issues/1).__
- [ ] ╰─ Ensure 100% code coverage for transactions.
- [ ] ╰─ Document transactions.
- [ ] ╰─ Add transaction example.
- [ ] __Implement indices.__
- [ ] ╰─ Ensure 100% code coverage for indices.
- [ ] ╰─ Document indices.
- [ ] ╰─ Add indices example.
## Use case
A data layer for simple [Small Web](https://ar.al/2020/08/07/what-is-the-small-web/) sites for basic public (e.g., anonymous comments on articles) or configuration data. Built for use in [Site.js](https://sitejs.org).
......@@ -69,6 +56,13 @@ __Not to farm people for their data.__ Surveillance capitalists can jog on now.
- __No schema, no migrations__: again, this is meant to be a very simple persistence, query, and observation layer for local server-side data. If you want schemas and migrations, take a look at nearly every other database out there.
## Like this? Fund us!
[Small Technology Foundation](https://small-tech.org) is a tiny, independent not-for-profit.
We exist in part thanks to patronage by people like you. If you share [our vision](https://small-tech.org/about/#small-technology) and want to support our work, please [become a patron or donate to us](https://small-tech.org/fund-us) today and help us continue to exist.
## To install
Currently, you need to clone or install from this repo as this is a work-in-progress and no releases have been made yet to npm.
......@@ -746,6 +740,17 @@ Please open an issue before starting to work on pull requests.
For code coverage, run `npm run coverage`.
## Ideas for post 1.0.0.
- [ ] __Implement [transactions](https://github.com/small-tech/jsdb/issues/1).__
- [ ] ╰─ Ensure 100% code coverage for transactions.
- [ ] ╰─ Document transactions.
- [ ] ╰─ Add transaction example.
- [ ] __Implement indices.__
- [ ] ╰─ Ensure 100% code coverage for indices.
- [ ] ╰─ Document indices.
- [ ] ╰─ Add indices example.
## Related projects, inspiration, etc.
- [Initial brainstorming (query language)](https://gist.github.com/aral/fc4115fdf338e02d735ae58e245817ce)
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment