Skip to content

Commit

Permalink
style: fix README layout and add .vscode to .gitignore
Browse files Browse the repository at this point in the history
  • Loading branch information
henri-hulski committed Jun 4, 2023
1 parent 5fcded5 commit d2b647c
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 9 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,4 @@ yarn.lock
/test/repo
/.nyc_output
/coverage
.vscode
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,17 +16,17 @@ There is no pre-required monorepo style or folder structure.

Things to check before gettings started:

1. Monorepo has correct 'repository' entry in package.json
2. Names in individual packages package.json file is correct (matches glob path). For example, a package in 'packages/@foo/bar' should have '@foo/bar' as name.
3. REPO_COOKER_GITHUB_TOKEN is set in the environment where the script runs.
4. .npmrc has an authToken (npm login) and REPO_COOKER_NPM_OTP is set if you have two factor authentication
5. git login if publishing release (see .travis.yml as example)
6. 'latest' npm tag for packages already released use a semver version matching /^\d+.\d+\.
1. Monorepo has correct 'repository' entry in package.json
2. Names in individual packages package.json file is correct (matches glob path). For example, a package in 'packages/@foo/bar' should have '@foo/bar' as name.
3. REPO_COOKER_GITHUB_TOKEN is set in the environment where the script runs.
4. .npmrc has an authToken (npm login) and REPO_COOKER_NPM_OTP is set if you have two factor authentication
5. git login if publishing release (see .travis.yml as example)
6. 'latest' npm tag for packages already released use a semver version matching /^\d+.\d+\.
(any version with appe)

## Usage examples

_package.json_
### `package.json`

```js
{
Expand All @@ -51,7 +51,7 @@ _package.json_
}
```

_repo-cooker/index.js_
### `repo-cooker/index.js`

This is the settings file.

Expand Down Expand Up @@ -89,7 +89,7 @@ const cooker = Cooker(process.argv, {
})
```

_repo-cooker/publish.js_
### `repo-cooker/publish.js`

```js
import { cooker } from './'
Expand Down

0 comments on commit d2b647c

Please sign in to comment.