Skip to content
This repository was archived by the owner on Aug 7, 2019. It is now read-only.

Commit 150b34f

Browse files
authored
Update README.md
1 parent de3f1c9 commit 150b34f

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

README.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,28 @@
11
# code-gov-fscp-react-component
22
FSCP Plugin for code-gov-web, built with Markdown and React
33

4+
## Install
5+
6+
The repository is distributed with [npm](https://www.npmjs.com/). After [installing npm](https://docs.npmjs.com/getting-started/installing-node), you can install `code-gov-fscp-react-component` with this command:
7+
```sh
8+
$ npm i @code.gov/code-gov-fscp-react-component
9+
```
10+
11+
## Usage
12+
13+
This package is meant to be used with the [code-gov-front-end](https://github.com/GSA/code-gov-front-end) project. Please follow the [configuration settings](https://github.com/GSA/code-gov-front-end/blob/master/CONFIGURATION.md#style) for the project.
14+
15+
## Link this package to edit Code.gov styles locally
16+
17+
You may want to view your changes in the code-gov-fscp-react-component repo on your local machine for testing. Follow these steps to do so:
18+
1. Clone the latest version of the `code-gov-fscp-react-component` repository.
19+
2. Run `npm install` to install the dependencies required for the package in the `code-gov-fscp-react-component` directory.
20+
3. Run `npm link` in the root level of the `code-gov-fscp-react-component` directory on your local machine.
21+
4. On the `code-gov-front-end` [project](https://github.com/GSA/code-gov-front-end#getting-started), clone the repository and run `npm install` if you haven’t done this already.
22+
5. Run `npm link @code.gov/code-gov-fscp-react-component` in the root level of the code-gov-front-end directory on your local machine.
23+
24+
You are now using the latest version of the code.gov design system via your cloned version when running the `code-gov-front-end` site on your local machine. To stop using this version, run `npm unlink @code.gov/code-gov-fscp-react-component` from the root level of the `code-gov-front-end` directory.
25+
426
# References:
527
- https://github.com/WhiteHouse/source-code-policy
628
- https://www.whitehouse.gov/sites/whitehouse.gov/files/omb/memoranda/2016/m_16_21.pdf

0 commit comments

Comments
 (0)