Skip to content

Commit 2ff0342

Browse files
authored
docs(readme): focus on write-heavy (#70)
1 parent cc35f17 commit 2ff0342

File tree

1 file changed

+29
-18
lines changed

1 file changed

+29
-18
lines changed

README.md

Lines changed: 29 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,25 @@
88
[![Bundle Size](https://img.shields.io/bundlephobia/minzip/homebase-react)](https://www.npmjs.com/package/homebase-react)
99
[![License](https://img.shields.io/github/license/homebaseio/homebase-react.svg)](LICENSE)
1010

11-
*The graph database for delightful React state management*
11+
*The React state management library for write-heavy applications*
1212

13+
## What and Why
1314

14-
Homebase React makes state management painless by enabling you to plug a relational graph database into your React application with just 3 lines of code. This is the same database that powers Roam Research and many other ClojureScript applications, but with an API that's familiar to React and JS developers.
15+
As data and our need to annotate and organize it grows, so does our need for supporting state in *write-heavy* applications.
16+
17+
To solve this problem, modern write-heavy applications such as Superhuman, Roam Research, and Facebook Messenger built their own embedded data layers to enable these more sophisticated user experiences.
18+
19+
Homebase-react enables developers to access the same embedded datalog database as Roam Research through React hooks. You no longer have to build out a team or learn specialized tools like Clojure in order to build a delightful write-heavy application.
20+
21+
22+
## Testimonials
23+
> "Homebase is executing on the vision of data usage, portability, and management we had when building Firebase. We never got there. I'm excited!"
24+
25+
- James Tamplin, Founder/CEO of Firebase
26+
27+
> Datalog is the future of end-user programming, personal productivity software, p2p software, etc.
28+
29+
- Chet Corcos, Founding Engineer of Notion
1530

1631
## Install
1732

@@ -26,22 +41,6 @@ yarn add homebase-react
2641
## Docs
2742
https://homebase.io/docs/homebase-react
2843

29-
## Features
30-
- The simplest and most declarative state management solution
31-
- The power of a backend relational graph database, but without having to wait on the network
32-
- Convenient JSON query syntax
33-
- Powerful Clojure style [Datalog](https://docs.datomic.com/on-prem/query.html) query syntax if you need it
34-
- Traverse your data graph like it's a big JSON object
35-
- Backup your data to the cloud
36-
37-
## Roadmap
38-
39-
1. Document integration with more backends
40-
1. Swap [Datascript](https://github.com/tonsky/datascript) out for [Datahike](https://github.com/replikativ/datahike)
41-
1. Immutability
42-
1. History / Change Tracking
43-
2. Persist to IndexedDB
44-
3. [Local-first](https://www.inkandswitch.com/local-first.html) conflict resolution for offline caching and sync between multiple devices
4544

4645
## Examples
4746
### Live Demos
@@ -189,6 +188,18 @@ This hook returns the current database client with some helpful functions for sy
189188

190189
Check out the [Firebase example](https://homebaseio.github.io/homebase-react/#!/example.todo_firebase) for a demonstration of how you might integrate a backend.
191190

191+
## Roadmap
192+
193+
1. Document integration with more backends
194+
2. Swap [Datascript](https://github.com/tonsky/datascript) out for [Datahike](https://github.com/replikativ/datahike)
195+
1. Immutability
196+
2. History / Change Tracking
197+
3. Persist to IndexedDB
198+
4. [Local-first](https://www.inkandswitch.com/local-first.html) conflict resolution for offline caching and sync between multiple devices
199+
200+
## Limitations
201+
Homebase React is currently not a good choice for read-heavy applications (e.g. Twitter, ecommerce). We plan to support these query patterns with our [platform](http://homebase.io) eventually.
202+
192203
## Development
193204

194205
```bash

0 commit comments

Comments
 (0)