Skip to content

Commit

Permalink
Merge pull request #218 from autonomys/chore-update-doc
Browse files Browse the repository at this point in the history
Add how to create an API key into the README
  • Loading branch information
clostao authored Jan 16, 2025
2 parents 4a008a1 + 51ff234 commit c3eb095
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions packages/auto-drive/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,13 @@ yarn add @autonomys/auto-drive

### How to use it?

To interact with the Auto-Drive API, you'll need to create an API key. Follow these steps:

- Go to [Auto-Drive](https://ai3.storage) and login with your preffered SSO.
- Once you're logged in, click on the profile section in the left sidebar menu.
- In the profile section, click on 'Create API Key'
- Read the modal message and click on generate

### How to upload a file from filepath? (Not available in browser)

Here is an example of how to use the `uploadFileFromFilepath` method to upload a file with optional encryption and compression:
Expand Down

0 comments on commit c3eb095

Please sign in to comment.