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.

Sign up for GitHub

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

Update README.md #117

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update README.md #117

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 7 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,23 +1,22 @@
# StoryKit

StoryKit is a React toolkit that allows builders to integrate and interact with Story's Proof of Creativity protocol with prebuilt IP management components.

## Installation

_StoryKit is currently a GitHub Package so you will need repo access and a personal access token to use._

Also you will need Node.js 20+.
Also, you will need Node.js 20+.

1 . Create a personal access token: [github.com/settings/tokens](https://github.com/settings/tokens).

2 . Create a `.npmrc` file in the root of your project and add the following, replacing `NPM_TOKEN` with your access token:

```bash
//npm.pkg.github.com/:_authToken=NPM_TOKEN
@storyprotocol/storykit:registry=https://npm.pkg.github.com
```

The first line authenticates you with the GitHub package registry, the second line tells npm to use the Storykit package from the GitHub registry.
The first line authenticates you with the GitHub package registry.
The second line tells npm to use the Storykit package from the GitHub registry.

3 . Add `.npmrc` to your `.gitignore` to keep your access token private.

Expand All @@ -37,7 +36,7 @@ To use StoryKit’s API functionalities, you’ll need two types of API keys:

2. SimpleHash API Key: You can generate an api token for free at [simplehash.com](https://simplehash.com/).

Add these keys to your environment configuration:
3. Add these keys to your environment configuration file:

```bash
NEXT_PUBLIC_STORY_PROTOCOL_X_API_KEY="YOUR_STORY_PROTOCOL_API_KEY_HERE"
Expand All @@ -48,7 +47,7 @@ NEXT_PUBLIC_SIMPLE_HASH_API_KEY="SIMPLEHASH_API_KEY_HERE"

To initialize StoryKit in your project, you’ll need to wrap your application in `QueryProvider` and `StoryKitProvider`.

we recommend doing this once in the root of the app.
We recommend doing this once in the root of the app.

```tsx
// app/layout.tsx
Expand Down Expand Up @@ -121,7 +120,7 @@ const ExampleComponent = () => {
};
```

Among the components that start with `Ip`, all except IpWidget require the IpProvider to supply asset data. Check the Storybook of each component for detailed usage.
All components that start with 'IP', except for IpWidget, require the IpProvider to supply asset data. Check the Storybook of each component for detailed usage.

```tsx
"use client";
Expand Down Expand Up @@ -159,7 +158,7 @@ pnpm example --filter @example/simple-setup
pnpm example --filter @example/custom-theme
```

The dev server will be running at [http://localhost:3000](http://localhost:3000)
The development server will be running at [http://localhost:3000]

See [the github repo](https://github.com/storyprotocol/storykit) and [the example app](https://github.com/storyprotocol/storykit/tree/main/examples/next-app).

Expand Down