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

Commit f71c435

Browse files
committed
chore: fine tuning for readme 💅
1 parent e537c7c commit f71c435

File tree

1 file changed

+14
-16
lines changed

1 file changed

+14
-16
lines changed

README.md

Lines changed: 14 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,8 @@
1616
</div>
1717

1818
<p align="center">
19-
<a href="https://oclif.io">
20-
<img src="https://img.shields.io/badge/cli-oclif-brightgreen.svg">
21-
</a>
22-
<a href="https://npmjs.org/package/@storyblok/create-demo">
19+
20+
<a href="https://npmjs.org/package/@storyblok/create-demo">
2321
<img src="https://img.shields.io/npm/v/%40storyblok%2Fcreate-demo">
2422
</a>
2523
<a href="https://npmjs.org/package/@storyblok/create-demo">
@@ -42,24 +40,24 @@
4240

4341
# Getting Started
4442

45-
1. Signup at https://app.storyblok.com/
46-
2. Create a new space and retrieve the space preview token under your space in "Settings -> Access Tokens" menu item
43+
1. Signup at https://app.storyblok.com/;
44+
2. Create a new space and retrieve the space preview token under your space in "Settings -> Access Tokens" menu item;
4745
3. Execute the following commands (use your preview access token when prompted when running the `npx` command):
4846

49-
```sh-session
47+
~~~bash
5048
npx @storyblok/create-demo@latest
5149

5250
cd my-app
5351
npm i && npm run dev
54-
```
52+
~~~
5553

5654
4. Open the Storyblok App following the URL suggested by the output provided by the commands. It depends on the HTTPS configuration and the port used by the frameworks.
5755

5856
# CLI Options
5957

6058
The CLI has different options that can be filled, you can see all the options by running `npx @storyblok/create-demo --help`:
6159

62-
```
60+
~~~
6361
OPTIONS
6462
-d, --folder=folder Folder path for the demo (e.g. my-demo)
6563
-f, --framework=framework Framework to use (e.g. remix)
@@ -68,23 +66,23 @@ OPTIONS
6866
-p, --packagemanager=packagemanager Package manager to use (yarn or npm)
6967
-r, --region=region Space region (e.g. EU, US or CN)
7068
-v, --version show CLI version
71-
```
69+
~~~
7270

73-
By using this you can skip the "questions" of the CLI and fill it with your options directly like so:
71+
By using this, you can skip the "questions" of the CLI and fill it with your options directly like so:
7472

75-
```
73+
~~~bash
7674
npx @storyblok/create-demo@latest --key YOUR_STORYBLOK_PREVIEW_TOKEN --region US
77-
```
75+
~~~
7876

7977

8078
### Local Development
8179

82-
If you want to contribute you can run the CLI locally and test it with this command:
80+
If you want to contribute, you can run the CLI locally and test it with this command:
8381

84-
```sh-session
82+
~~~bash
8583
npm i
8684
./bin/dev --key YOUR_STORYBLOK_PREVIEW_TOKEN
87-
```
85+
~~~
8886

8987
#### Framework Options
9088

0 commit comments

Comments
 (0)