-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #85 from maxatdetroit/Docs.1
Update README
- Loading branch information
Showing
1 changed file
with
5 additions
and
4 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 |
---|---|---|
|
@@ -7,9 +7,9 @@ This project was created using: | |
- [Webpack](https://webpack.js.org/) as a web application bundler. | ||
- [Yarn](https://classic.yarnpkg.com/en/) to manage project dependencies. | ||
- [MapLibre](https://maplibre.org/) for map framework. | ||
- [Storybook](https://www.cypress.io/) for UI component management. | ||
- [Storybook](https://storybook.js.org/) for UI component management. | ||
|
||
## Implenentation | ||
## Using in Your Project | ||
1. Load package into your project | ||
``` | ||
yarn add @cityofdetroit/cod-design-system | ||
|
@@ -18,14 +18,15 @@ This project was created using: | |
npm i @cityofdetroit/cod-design-system | ||
``` | ||
## Setup Local Environment. | ||
## Contributing | ||
### Setup Local Environment | ||
1. Download the repo. | ||
``` | ||
$ git clone [email protected]:jedgar1mx/COD-Design-System.git | ||
``` | ||
2. Install node dependencies. | ||
``` | ||
$ yarn | ||
``` | ||
|