Skip to content

Commit

Permalink
doc updates
Browse files Browse the repository at this point in the history
  • Loading branch information
erdo committed Apr 14, 2024
1 parent 1a42f21 commit cfacdc9
Showing 1 changed file with 10 additions and 17 deletions.
27 changes: 10 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,25 @@
## n8 [![circleci](https://circleci.com/gh/erdo/n8.svg?style=svg)](https://circleci.com/gh/erdo/n8)

** WIP if you want to help, open an issue and submit a PR! **
⚠️** WIP (~75% feature complete) & help wanted 🙏(check the issues) ** ⚠️

- pure kotlin
- low config
- minimally coupled
- type safe
![example app screenshot landscape view](example-app/screenshot-land.png)

Clone the repo and run the sample app... (that's the quickest way to understand what's going on here)

### Usage

n8 navigation is: pure kotlin, low config, minimally coupled & type safe, but do see the little sample app and unit tests for the full picture

``` kotlin
implementation("co.early.n8:n8-core:0.0.4")
implementation("co.early.n8:n8-compose:0.0.4")
```

GPG fingerprint (for optionally verifying the Maven packages): <strong>5B83EC7248CCAEED24076AF87D1CC9121D51BA24</strong> see repo root for the public certificate.

### Usage

(But see the little sample app and unit tests for the full picture)

_Note: a legacy or hybrid android app that still uses fragments or multiple activities, can't maintain its back stack in the same stateful manner as a 100% compose app can and therefore won't get much utility from N8_

---

It's not necessary to specify navigation routes upfront, n8 just builds the navigation graph
as you go, ensuring that back operations always make sense. These are the main functions your code
needs to call to navigate around the app:
Expand Down Expand Up @@ -466,13 +466,6 @@ available for client use too which should make life easier.
//TODO
## Example App
![example app screenshot](example-app/screenshot.png)
![example app screenshot landscape view](example-app/screenshot-land.png)
There is a mini android app in this repo if you want something to play around with
### Some ideas for what to do next
- improve / simplify code comments & docs
Expand Down

0 comments on commit cfacdc9

Please sign in to comment.