8000 Add clarity to readme by becomingbabyman · Pull Request #6 · homebaseio/homebase-react · GitHub
[go: up one dir, main page]

Skip to content

Add clarity to readme #6

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

Merged
merged 2 commits into from
Nov 8, 2020
Merged

Add clarity to readme #6

merged 2 commits into from
Nov 8, 2020

Conversation

becomingbabyman
Copy link
Member

Updates to the readme taking some of our most recent conversations into account. I tried to disambiguate the API so that all the features are documented if only briefly. This was written on my iPad and I don’t think spellcheck was working so need to give it another pass for spelling.

@becomingba
8000
byman becomingbabyman added the documentation Improvements or additions to documentation label Nov 7, 2020
@becomingbabyman becomingbabyman self-assigned this Nov 7, 2020
README.md Outdated
schema: {
todo: {
project: { type: 'ref' },
name: { unique: 'identity' }
}
},

// Initial data is like it sound.
Copy link
Contributor

Choose a reason for hiding this comment

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

*sounds

Copy link
Member Author

Choose a reason for hiding this comment

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

ty

@rubinovitz
Copy link
Contributor

@smothers I feel like this is so much more true that what we want to do and speaks to the user feedback we've gotten really well. I love it! Added a typo correction but otherwise looks great to me. Excited to keep dialing this in :)

Copy link
Contributor
@rubinovitz rubinovitz left a comment

Choose a reason for hiding this comment

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

LGTM 🚀

@becomingbabyman becomingbabyman merged commit c8efbaa into master Nov 8, 2020
@becomingbabyman becomingbabyman deleted the add-clarity-to-readme branch November 8, 2020 19:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants
0