update readme

This commit is contained in:
Silas 2021-11-25 12:57:49 -05:00
parent a9c5473c1c
commit 5ebd3f3564
Signed by: silentsilas
GPG Key ID: 4199EFB7DAA34349
1 changed files with 12 additions and 35 deletions

View File

@ -1,46 +1,23 @@
# Getting Started with Create React App
# Intended UI
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
A storybook comprising of Intended Link's UI components.
## Available Scripts
## Usage
In the project directory, you can run:
Run `npm install @intended/intended-ui`
### `yarn start`
In your project files, import whichever components you need `import { Icon } from @intended/intended-ui`
Runs the app in the development mode.\
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
## Installation
The page will reload if you make edits.\
You will also see any lint errors in the console.
`npm install`
### `yarn test`
## Development
Launches the test runner in the interactive watch mode.\
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
`npm run storybook`
### `yarn build`
## Deployment
Builds the app for production to the `build` folder.\
It correctly bundles React in production mode and optimizes the build for the best performance.
`npm run build`
The build is minified and the filenames include the hashes.\
Your app is ready to be deployed!
See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
### `yarn eject`
**Note: this is a one-way operation. Once you `eject`, you cant go back!**
If you arent satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point youre on your own.
You dont have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldnt feel obligated to use this feature. However we understand that this tool wouldnt be useful if you couldnt customize it when you are ready for it.
## Learn More
You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
To learn React, check out the [React documentation](https://reactjs.org/).
Then run `npm publish --access public` while logged in as an Intended org user.