8000 Update README.md with demos + move roadmap to the bottom (#4) · homebaseio/homebase-react@61cb7d6 · GitHub
[go: up one dir, main page]

Skip to content

Commit 61cb7d6

Browse files
authored
Update README.md with demos + move roadmap to the bottom (#4)
1 parent 1e0eae2 commit 61cb7d6

File tree

1 file changed

+17
-12
lines changed

1 file changed

+17
-12
lines changed

README.md

Lines changed: 17 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,11 @@ yarn add homebase-react
1616
https://www.notion.so/Homebase-Alpha-Docs-0f0e22f3adcd4e9d87a13440ab0c7a0b
1717

1818
## Examples
19-
https://homebaseio.github.io/homebase-react
19+
### Live Demos
20+
You can see our hosted live demos [here](https://homebaseio.github.io/homebase-react)
21+
22+
### Code Examples
23+
You can clone and run our React code examples [here](https://github.com/homebaseio/create-homebase-app).
2024

2125
## Purpose
2226

@@ -32,16 +36,6 @@ Homebase React lets you plug a relational database into your React app.
3236

3337
It is immediately more intuitive than a denormalized JSON store, and over time it will get better as we add more local-first features to it.
3438

35-
## Roadmap
36-
37-
1. Improve performance
38-
1. Document integration with backends
39-
1. Swap [Datascript](https://github.com/tonsky/datascript) out for [Datahike](https://github.com/replikativ/datahike)
40-
1. Immutability
41-
1. History / Change Tracking
42-
1. Persist to IndexDB
43-
1. Local-first conflict resolution for offline caching and sync between multiple devices
44-
4539
## API Overview
4640

4741
### `HomebaseProvider`
@@ -126,7 +120,18 @@ npx shadow-cljs watch :dev
126120
Open http://localhost:3000
127121

128122

123+
## Roadmap
124+
125+
1. Improve performance
126+
1. Document integration with backends
127+
1. Swap [Datascript](https://github.com/tonsky/datascript) out for [Datahike](https://github.com/replikativ/datahike)
128+
1. Immutability
129+
1. History / Change Tracking
130+
1. Persist to IndexDB
131+
1. Local-first conflict resolution for offline caching and sync between multiple devices
132+
133+
129134
## Authors
130135

131136
- Chris Smothers ([@csmothers](https://twitter.com/csmothers)) – [Homebase](https://www.homebase.io/)
132-
- JB Rubinovitz ([@rubinovitz](https://twitter.com/rubinovitz)) – [Homebase](https://www.homebase.io/)
137+
- JB Rubinovitz ([@rubinovitz](https://twitter.com/rubinovitz)) – [Homebase](https://www.homebase.io/)

0 commit comments

Comments
 (0)
0