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

docs fix README.md #433

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
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
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -37,7 +37,7 @@ If you're feeling adventurous, feel free to open a pull request [here](https://g
# WIP 👷‍♀️

> Below section is WIP.
> Until we add ids to every spec, deploy specs as you normally would.
> Until we add IDs to every spec, deploy specs as you normally would.
## Alchemists 👩‍🔬

@@ -47,11 +47,11 @@ To speed up your development, 2 commands are now available.
- `npm run update spec.yaml`

You no longer need to run the `rdme` command line directly to push to staging.
You also no longer need to pass an API key and readme id! 🎉
You also no longer need to pass an API key and readme ID! 🎉

### First time?

> Make sure you first ran through the steps [above](#getting-started).
> Make sure you first run through the steps [above](#getting-started).
1. Clone `.env.template` into `.env`.

@@ -79,7 +79,7 @@ This will:

- deploy your spec to readme
- create a page and id
- associate page id with your spec
- associate page ID with your spec

3. Your spec will be updated with a `x-readme.id` field. This is super important to ensure updates work smoothly in the future!

@@ -101,7 +101,7 @@ npm run create spec.yaml
npm run update spec.yaml
```

3. Check the spec has a `x-readme.id` property. This id is used to match the spec on Readme's side.
3. Check the spec has a `x-readme.id` property. This ID is used to match the spec on Readme's side.
4. Reach out to Bastien if you have any issues running the scripts.

## Linting