-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
4 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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 | ||
|
||
|