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

chore: Prepare README for release #38

Merged
merged 5 commits into from
Aug 1, 2023
Merged

chore: Prepare README for release #38

merged 5 commits into from
Aug 1, 2023

Conversation

d-jeffery
Copy link
Contributor

@d-jeffery d-jeffery commented Aug 1, 2023 •
edited
Loading

Preparing README for users

Description

  • Added images for branding and README help
  • Added info for usage, development and distribution
  • Changed display name in package.json

References

See README

Review Checklist

  • I have clicked on "allow edits by maintainers".
  • I have added documentation for new/changed functionality in this PR or in a PR to openfga.dev [Provide a link to any relevant PRs in the references section above]
  • The correct base branch is being used, if not main
  • I have added tests to validate that the change in functionality is working as expected

@d-jeffery d-jeffery added the documentation Improvements or additions to documentation label Aug 1, 2023
@d-jeffery d-jeffery marked this pull request as ready for review August 1, 2023 22:09
@d-jeffery d-jeffery requested a review from a team as a code owner August 1, 2023 22:09
adriantam
adriantam reviewed Aug 1, 2023
View reviewed changes
README.md Outdated Show resolved Hide resolved
@adriantam adriantam merged commit c11e6ac into main Aug 1, 2023
5 checks passed
@adriantam adriantam deleted the chore/prepare-release branch August 1, 2023 23:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@adriantam adriantam adriantam approved these changes

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Fix and update the README: add screenshots, installation instructions, etc..
2 participants
@d-jeffery @adriantam