-
Notifications
You must be signed in to change notification settings - Fork 0
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Vamp up the README #446
Vamp up the README #446
Conversation
🔥 HEADS UP: you'll see i've added a test here: tests/README.test.ts 😈 it parses the README for the code example. this does mean the read me is now a sensitive place however it also means that if you change the api surface and dont update the read me to match the executable it will fail the tests! 🔥 |
@frankiebee are you done with this PR? If so, I'd like to run through it before it gets merged. Don't wanna step on your toes if you're still working on it though. |
i'm done writing doc words so please take a look! i would like you too |
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:
BONUS: