From d2b647ccf90453de6afdb6a6d0d03dddaca3fde7 Mon Sep 17 00:00:00 2001 From: Henri Hulski Date: Sun, 12 Mar 2023 03:10:50 +0100 Subject: [PATCH] style: fix README layout and add .vscode to .gitignore --- .gitignore | 1 + README.md | 18 +++++++++--------- 2 files changed, 10 insertions(+), 9 deletions(-) diff --git a/.gitignore b/.gitignore index bb7101c..e0a659f 100644 --- a/.gitignore +++ b/.gitignore @@ -10,3 +10,4 @@ yarn.lock /test/repo /.nyc_output /coverage +.vscode diff --git a/README.md b/README.md index 3b75ece..0ac4693 100644 --- a/README.md +++ b/README.md @@ -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 { @@ -51,7 +51,7 @@ _package.json_ } ``` -_repo-cooker/index.js_ +### `repo-cooker/index.js` This is the settings file. @@ -89,7 +89,7 @@ const cooker = Cooker(process.argv, { }) ``` -_repo-cooker/publish.js_ +### `repo-cooker/publish.js` ```js import { cooker } from './'