Skip to content

Commit

Permalink
Merge pull request #85 from maxatdetroit/Docs.1
Browse files Browse the repository at this point in the history
Update README
  • Loading branch information
jedgar1mx authored Sep 6, 2023
2 parents 31726d8 + 85e4f9c commit 9c07e77
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
```
Expand Down

0 comments on commit 9c07e77

Please sign in to comment.