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" instructions to the readme #32

Merged
merged 3 commits into from
Dec 11, 2024

Conversation

ramfox
Copy link
Contributor

@ramfox ramfox commented Dec 6, 2024

Description

Add an install page with "Getting Started" instructions. Also, pull those instructions in to our generated docs.

This is a separate page from the README, since it gives us flexibility on how to import the content in other locations (rustdoc & iroh.computer/docs).

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-blobs/pr/32/docs/iroh_blobs/

Last updated: 2024-12-11T10:19:35Z

INSTALL.md Outdated Show resolved Hide resolved
src/lib.rs Outdated Show resolved Hide resolved
INSTALL.md Outdated Show resolved Hide resolved
@ramfox ramfox requested a review from dignifiedquire December 6, 2024 21:41
@ramfox ramfox changed the title docs: add INSTALL.md with "getting started" instructions docs: add "getting started" instructions to the readme Dec 6, 2024
README.md Outdated Show resolved Hide resolved
@rklaehn rklaehn merged commit dd6673e into main Dec 11, 2024
23 of 24 checks passed
@rklaehn rklaehn deleted the install-instructions branch December 11, 2024 10:23

// do fun stuff with the blobs protocol!
// make sure not to drop the local_pool before you are finished
router.shutdown().await?;
drop(local_pool);
drop(tags_client);
Copy link
Collaborator

Choose a reason for hiding this comment

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

explicit drops? why?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants