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.

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

docs: add "Getting Started" section to the README and add the readme to the docs #19

Merged
merged 4 commits into from
Dec 11, 2024

Conversation

ramfox
Copy link
Contributor

@ramfox ramfox commented Dec 6, 2024

Add "Getting Started" section to the README and add the readme to the docs

Also duplicate the code from the readme into an example so it gets compiled.

Copy link

github-actions bot commented Dec 6, 2024

Documentation for this PR has been generated and is available at: https://n0-computer.github.io/iroh-docs/pr/19/docs/iroh_docs/

Last updated: 2024-12-11T10:41:28Z

Copy link
Contributor

@dignifiedquire dignifiedquire left a comment

Choose a reason for hiding this comment

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

much nicer now

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Copy link
Contributor

@rklaehn rklaehn left a comment

Choose a reason for hiding this comment

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

Great improvement, just left some minor nits regarding the example code.

@ramfox ramfox merged commit 98e2e17 into main Dec 11, 2024
24 checks passed
@ramfox ramfox deleted the getting-started branch December 11, 2024 17:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

3 participants