Skip to content

Commit

Permalink
📖 Remove reference to github packages from readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
jwir3 committed Apr 26, 2023
1 parent 661bea5 commit 0e55cfb
Showing 1 changed file with 3 additions and 15 deletions.
18 changes: 3 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,7 @@
A lightweight tool for deploying node applications from within a source repository

## Usage
1. You will need to add the following to an `.npmrc` file in order to get access
to packages hosted by `@foamfactory` on github packages:
```
registry=https://registry.npmjs.org
@foamfactoryio:registry=https://npm.pkg.github.com
```
Alternatively, if using `yarn`, you need to add the following `.yarnrc`:
```
"@foamfactoryio:registry" "https://npm.pkg.github.com/"
registry "https://registry.npmjs.org/"
```

2. Inside of your project, run:
1. Inside of your project, run:
```
npm install --save-dev @foamfactoryio/shipout
```
Expand All @@ -23,9 +11,9 @@ Alternatively, if using `yarn`, run:
yarn add -D @foamfactoryio/shipout
```

3. Add your configuration to your `package.json` or environment variables (see
2. Add your configuration to your `package.json` or environment variables (see
[Configuration](#configuration)), below.
4. Add a `shipout` script to your `package.json` (or, alternatively, use
3. Add a `shipout` script to your `package.json` (or, alternatively, use
`publish` if you so desire):
```
"scripts": {
Expand Down

0 comments on commit 0e55cfb

Please sign in to comment.