Skip to content

docs(README): write-heavy readme #70

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 2 commits into from
Mar 3, 2021
Merged

docs(README): write-heavy readme #70

merged 2 commits into from
Mar 3, 2021

Conversation

rubinovitz
Copy link
Contributor

PR Description

README centered on write-heavy application use case

PR Checklist

Testing

  • added relevant test coverage
  • no tests needed

Docs

Typescript

  • added or edited relevant Typescript type declarations
  • no type declaration updates needed

Merging

For maintainers.

To merge, select "Squash and Merge". Then:

  1. Make sure the top commit message follows Angular Git Commit Guidelines,
  2. Delete all other commit messages in the description, but keep any lines designating co-authors so contributors will retain credit for their contributions.

@rubinovitz rubinovitz requested a review from crs48 March 3, 2021 04:00
@vercel
Copy link

vercel bot commented Mar 3, 2021 •
edited
Loading

This pull request is being automatically deployed with Vercel (learn more).
To see the status of your deployments, click below or on the icon next to each commit.

homebase-example-counter – ./examples/counter

🔍 Inspect: https://vercel.com/homebaseio/homebase-example-counter/7z91jM94c7eThREZBvfBszxN8UTH
✅ Preview: https://homebase-example-counter-git-readme-v2-homebaseio.vercel.app

homebase-example-todo – ./examples/todo

🔍 Inspect: https://vercel.com/homebaseio/homebase-example-todo/EaoS5tzW5z3B9DimHPBHBmPK5a8S
✅ Preview: https://homebase-example-todo-git-readme-v2-homebaseio.vercel.app

homebase-example-ts-firebase-todo – ./examples/typescript-firebase-todo

🔍 Inspect: https://vercel.com/homebaseio/homebase-example-ts-firebase-todo/DuJZ8gzeZM9EdLfZ2Tug7oQNVUnf
✅ Preview: https://homebase-example-ts-firebase-todo-git-readme-v2-homebaseio.vercel.app

homebase-example-roam – ./examples/roam

🔍 Inspect: https://vercel.com/homebaseio/homebase-example-roam/2RS49qPsSJ4N8vGSZLL73hBJcGve
✅ Preview: https://homebase-example-roam-git-readme-v2-homebaseio.vercel.app

@rubinovitz rubinovitz added the documentation Improvements or additions to documentation label Mar 3, 2021
crs48
crs48 approved these changes Mar 3, 2021
View reviewed changes
Copy link
Member

@crs48 crs48 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great!

@crs48 crs48 merged commit 2ff0342 into master Mar 3, 2021
@crs48 crs48 deleted the readme-v2 branch March 3, 2021 16:37
@github-actions
Copy link

github-actions bot commented Mar 6, 2021

🎉 This PR is included in version 0.5.3 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@crs48 crs48 crs48 approved these changes

Assignees

@rubinovitz rubinovitz

Labels
documentation Improvements or additions to documentation released
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@rubinovitz @crs48