Skip to content
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

README: reorganize, add callouts #56

Merged
merged 1 commit into from
Oct 7, 2024
Merged

README: reorganize, add callouts #56

merged 1 commit into from
Oct 7, 2024

Conversation

woodruffw
Copy link
Member

This cleans up the README in a few important ways:

  • Moves the CLI docs below the API docs, and emphasizes that they're for experimentation and not integration.
  • Adds annotations/callouts throughout where appropriate.
  • Updates the library usage examples.

See #55.

@woodruffw
README: reorganize, add callouts
3de13f6 
Signed-off-by: William Woodruff <[email protected]>
@woodruffw woodruffw added the component:documentation 📖 Improvements or additions to documentation label Oct 7, 2024
@woodruffw woodruffw self-assigned this Oct 7, 2024
facutuesca
facutuesca approved these changes Oct 7, 2024
View reviewed changes
Copy link
Collaborator

@facutuesca facutuesca left a comment

Choose a reason for hiding this comment

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

LGTM!

@woodruffw woodruffw merged commit 4a0425f into main Oct 7, 2024
4 checks passed
@woodruffw woodruffw deleted the ww/readme branch October 7, 2024 15:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@facutuesca facutuesca facutuesca approved these changes

Assignees

@woodruffw woodruffw

Labels
component:documentation 📖 Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@woodruffw @facutuesca