Skip to content

Commit

Permalink
Update require instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
froboy authored Dec 19, 2018
1 parent 59b0036 commit 45af4d5
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,11 +84,12 @@ TODO

### Requiring this project as a dependency

Because this repo is currently private, it can't be included via public registries. I can still be included via `npm`/`yarn` as follows, assuming you have read access to this repo and GitHub SSH keys set up locally:
Deploying this package produces production-ready JS and CSS files that can be referenced in a project as external dependencies. For example:

`yarn add @palantirnet/federated-search-react:git+ssh://[email protected]:palantirnet/federated-search-react.git#v1.0.1`
- CSS: `https://cdn.jsdelivr.net/gh/palantirnet/[email protected]/css/main.cf6a58ce.css`
- JS: `https://cdn.jsdelivr.net/gh/palantirnet/[email protected]/js/main.d41fc3fe.js`

To update the package, increment the version number accordingly and run `yarn install`.
To update the package, increment the version number AND hash for each file based on the current release.

## Additional documentation

Expand Down

0 comments on commit 45af4d5

Please sign in to comment.