Skip to content
This repository was archived by the owner on Jul 22, 2025. It is now read-only.

Commit e537c7c

Browse files
committed
feat: improving readme
1 parent 7dedbb1 commit e537c7c

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@
4343
# Getting Started
4444

4545
1. Signup at https://app.storyblok.com/
46-
2. Create a new space and retrieve the space preview token under Space -> Settings -> Api Keys
46+
2. Create a new space and retrieve the space preview token under your space in "Settings -> Access Tokens" menu item
4747
3. Execute the following commands (use your preview access token when prompted when running the `npx` command):
4848

4949
```sh-session
@@ -83,12 +83,12 @@ If you want to contribute you can run the CLI locally and test it with this comm
8383

8484
```sh-session
8585
npm i
86-
./bin/run --key YOUR_STORYBLOK_PREVIEW_TOKEN
86+
./bin/dev --key YOUR_STORYBLOK_PREVIEW_TOKEN
8787
```
8888

8989
#### Framework Options
9090

91-
The framework options can be set in `src/frameworks.js` and work in combination with the [getting-started](https://github.com/storyblok/getting-started) repository
91+
The framework options can be set in `src/lib/frameworks.ts` and work in combination with the [getting-started](https://github.com/storyblok/getting-started) or The Ultimate Tutorial repositories:
9292

9393
- `name`: name of the framework
9494
- `value`: cli value to use for reference
@@ -98,7 +98,8 @@ The framework options can be set in `src/frameworks.js` and work in combination
9898
- `bridge`: file that is loading the bridge
9999
- `public`: public folder path for the static files
100100
- `port`: port the framework starts,
101-
- `branch`: (optional) for testing other branches on the `getting-started` repository
101+
- `repositoryUrl`: (optional) the URL repository for cloning the template;
102+
- `branch`: (optional) for setting a specific branches
102103
- `https`: (optional) if the framework starts with https
103104
- `submodules`: (optional) if the framework in `getting-started` is a submodule
104105
- `tutorialLink`: (optional) - link to the framwork tutorial

0 commit comments

Comments
 (0)