Skip to content

Commit

Permalink
Vamp up the README (#446)
Browse files Browse the repository at this point in the history
closes #443 
The purpose of this PR is to "kick off" better docs and to get one step
closer to getting our docs up on the docs website:

### What the README has now: 
- [x] Quick overview (what this SDK is for, who it's for, some example
use-cases)
- [x] Installation instructions
- [x] Basic usage example (bonus: runnable code)
- [ ] Links to detailed docs over at docs.entropy.xyz (@johnnymatthews
this one is on you)

### BONUS:
- [x] test for the code example (if this ever fails the readme needs to
be updated!)
  • Loading branch information
frankiebee authored Jan 9, 2025
2 parents 00b7773 + 49b89f0 commit ba9290d
Show file tree
Hide file tree
Showing 4 changed files with 157 additions and 490 deletions.
Loading

0 comments on commit ba9290d

Please sign in to comment.