Skip to content

Commit

Permalink
(chore) Update example site README.md (#87)
Browse files Browse the repository at this point in the history
  • Loading branch information
aeharding authored Feb 20, 2024
1 parent b442d97 commit a84e696
Showing 1 changed file with 4 additions and 28 deletions.
32 changes: 4 additions & 28 deletions example/README.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,18 @@
# Getting Started with Create React App
# metar-taf-parser example site

This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
This example site show the capabilities of the metar-taf-parser library.

## Available Scripts

In the project directory, you can run:

### `pnpm start`

Runs the app in the development mode.\
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
Runs the app in the development mode.

The page will reload if you make edits.\
The page will reload if you make edits.
You will also see any lint errors in the console.

### `pnpm test`

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.

### `pnpm build`

Builds the app for production to the `build` folder.\
Expand All @@ -27,24 +21,6 @@ It correctly bundles React in production mode and optimizes the build for the be
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.

### `pnpm eject`

**Note: this is a one-way operation. Once you `eject`, you can’t go back!**

If you aren’t 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 you’re on your own.

You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.

### `pnpm deploy`

Builds + deploys app to Github Pages.

## 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/).

0 comments on commit a84e696

Please sign in to comment.