Skip to content

Commit

Permalink
fix: add more docs (#368)
Browse files Browse the repository at this point in the history
`release-please` doesn't create a release for chores, so my last attempt
to create a new keyring-core release failed.

Add some basic docs, and call this a `fix` to get `release-please` to do
the right thing.
  • Loading branch information
travis authored Feb 3, 2023
1 parent 8cd5bb6 commit c339d82
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions packages/keyring-core/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,16 @@ import * as RSASigner from '@ucanto/principal/rsa'
const DB_NAME = 'w3ui'
const DB_STORE_NAME = 'keyring'

/**
* A Space is the core organizational structure of web3-storage,
* similar to a bucket in S3 but with some special properties.
*
* At its core, a Space is just a public/private keypair that
* that users can associate web3-storage uploads with. The keypair
* is stored locally in a user's browser and can be registered with
* web3-storage to enable uploads and allow for recovery of upload
* capabilities in case the keypair is lost.
*/
export class Space implements Principal {
#did: DID
#meta: Record<string, any>
Expand Down

0 comments on commit c339d82

Please sign in to comment.