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

docs: add getting started guide to readme #1094

Merged
merged 1 commit into from
Oct 28, 2022
Merged

docs: add getting started guide to readme #1094

merged 1 commit into from
Oct 28, 2022

Conversation

hperl
Copy link
Collaborator

@hperl hperl commented Oct 27, 2022

Add a getting started section to the readme.

Related issue(s)

Checklist

  • I have read the contributing guidelines.
  • I have referenced an issue containing the design document if my change
    introduces a new feature.
  • I am following the
    contributing code guidelines.
  • I have read the security policy.
  • I confirm that this pull request does not address a security
    vulnerability. If this pull request addresses a security vulnerability, I
    confirm that I got the approval (please contact
    security@ory.sh) from the maintainers to push
    the changes.
  • I have added tests that prove my fix is effective or that my feature
    works.
  • I have added or changed the documentation.

Further Comments

@hperl hperl requested a review from zepatrik as a code owner October 27, 2022 14:37
@hperl hperl requested a review from aeneasr October 27, 2022 14:37
@hperl hperl self-assigned this Oct 27, 2022
aeneasr
aeneasr approved these changes Oct 27, 2022
View reviewed changes
Copy link
Member

@aeneasr aeneasr left a comment

Choose a reason for hiding this comment

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

Sweet!

README.md Outdated Show resolved Hide resolved
zepatrik
zepatrik reviewed Oct 27, 2022
View reviewed changes
Copy link
Member

@zepatrik zepatrik left a comment

Choose a reason for hiding this comment

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

Looks good, as a first version 👍

@hperl @aeneasr
docs: add getting started guide to readme
1a25995 
Co-authored-by: hackerman <3372410+aeneasr@users.noreply.github.com>
@hperl hperl force-pushed the hperl/getting-started-readme branch from 4ed2d76 to 1a25995 Compare October 28, 2022 06:52
@hperl hperl enabled auto-merge (rebase) October 28, 2022 06:52
@hperl
Copy link
Collaborator Author

hperl commented Oct 28, 2022

Looks good, as a first version +1

Thanks! We should revisit once the Ory CLI gains check abilities.

@zepatrik zepatrik merged commit e3b88d2 into master Oct 28, 2022
@zepatrik zepatrik deleted the hperl/getting-started-readme branch October 28, 2022 15:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@zepatrik zepatrik zepatrik left review comments

@aeneasr aeneasr aeneasr approved these changes

Assignees

@hperl hperl

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@hperl @aeneasr @zepatrik