docs: update main readme for new devs. #1119
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Create a terse, developer focused "just show me" style readme for the main landing page of the w3up repo. previous readme was more of contributing guide so move it there per https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors#adding-a-contributing-file License: MIT Signed-off-by: Oli Evans <oli@protocol.ai>
alanshaw
requested changes
Nov 14, 2023
|
|
||
| ## Usage | ||
|
|
||
| Store your files with web3.storage and retrieve them via their unique Content ID. Our tools make it simple to hash your content locally, so you can verify the service only ever stores the exact bytes you asked us to. Pick the method of using with web3.storage that works for you! |
There was a problem hiding this comment.
Suggested change
| Store your files with web3.storage and retrieve them via their unique Content ID. Our tools make it simple to hash your content locally, so you can verify the service only ever stores the exact bytes you asked us to. Pick the method of using with web3.storage that works for you! | |
| Store your files with web3.storage and retrieve them via their unique Content ID. Our tools make it simple to hash your content locally, so you can verify the service only ever stores the exact bytes you asked us to. Pick the method of using web3.storage that works for you! |
|
|
||
| // lets go! | ||
| const files = await getFilesFromPaths(process.env.PATH_TO_ADD) | ||
| const cid = await client.put(files) |
There was a problem hiding this comment.
Suggested change
| const cid = await client.put(files) | |
| const cid = await client.uploadDirectory(files) |
|
|
||
| ### Command Line | ||
|
|
||
| Install [`@web3-storage/w3cli`](https://github.com/web3-storage/w3cli#readme) globally and save your api token then add your files to web3! It calculates the root CID for your files locally before sending them to web3.storage. |
There was a problem hiding this comment.
Suggested change
| Install [`@web3-storage/w3cli`](https://github.com/web3-storage/w3cli#readme) globally and save your api token then add your files to web3! It calculates the root CID for your files locally before sending them to web3.storage. | |
| Install [`@web3-storage/w3cli`](https://github.com/web3-storage/w3cli#readme) globally and save your API token then add your files to web3! It calculates the root CID for your files locally before sending them to web3.storage. |
Comment on lines
+59
to
+66
| # verify your email | ||
| $ w3 authorize alice@example.com | ||
|
|
||
| # create a Space, a DID namespace for your files... like a bucket. | ||
| $ w3 space create Documents | ||
|
|
||
| # defaults to registering you with web3.storage | ||
| $ w3 space register |
There was a problem hiding this comment.
Suggested change
| # verify your email | |
| $ w3 authorize alice@example.com | |
| # create a Space, a DID namespace for your files... like a bucket. | |
| $ w3 space create Documents | |
| # defaults to registering you with web3.storage | |
| $ w3 space register | |
| # verify your email | |
| $ w3 login alice@example.com | |
| # create a Space, a DID namespace for your files... like a bucket. | |
| $ w3 space create Documents |
|
|
||
| All welcome! web3.storage is open-source. See the [contributing guide](./CONTRIBUTING.md) | ||
|
|
||
| This project uses node v18 and `pnpm`. It's a monorepo that use [pnpm workspaces](https://pnpm.io/workspaces) to handle resolving dependencies between the local [`packages`](https://github.com/web3-storage/w3up/tree/main/packages) |
There was a problem hiding this comment.
Suggested change
| This project uses node v18 and `pnpm`. It's a monorepo that use [pnpm workspaces](https://pnpm.io/workspaces) to handle resolving dependencies between the local [`packages`](https://github.com/web3-storage/w3up/tree/main/packages) | |
| This project uses node v18 and `pnpm`. It's a monorepo that uses [pnpm workspaces](https://pnpm.io/workspaces) to handle resolving dependencies between the local [`packages`](https://github.com/web3-storage/w3up/tree/main/packages) |
olizilla
added a commit
that referenced
this pull request
Nov 14, 2023
applies fixes raised in #1119 License: MIT Signed-off-by: Oli Evans <oli@protocol.ai>
Merged
olizilla
added a commit
that referenced
this pull request
Nov 14, 2023
applies fixes raised in #1119 License: MIT Signed-off-by: Oli Evans <oli@protocol.ai>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Create a terse, developer focused "just show me" style readme for the main landing page of the w3up repo. this does not attempt to explain everything, just to show, with as little overhead as possible, how to do the basics with the new api.
previous readme was more of contributing guide so move it there per https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors#adding-a-contributing-file
License: MIT