From a55275e6113207dc9a7da38c3d80e6da0ce91962 Mon Sep 17 00:00:00 2001 From: alsherko Date: Thu, 28 Nov 2019 11:34:50 +0300 Subject: [PATCH] update README.md --- README.md | 70 +++++++------------------------------------------------ 1 file changed, 8 insertions(+), 62 deletions(-) diff --git a/README.md b/README.md index 859d27a..1d49d20 100644 --- a/README.md +++ b/README.md @@ -1,68 +1,14 @@ -This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app). +🦄 **React News** is a React App showing news results uses data from [News API](https://newsapi.org/) 🦄 -## Available Scripts +## Features -In the project directory, you can run: +- 🌱 **Simple**: Bootstrapped with [Create React App](https://github.com/facebookincubator/create-react-app) and using [React](https://facebook.github.io/react/) -### `npm start` +- ⏳ **Real-time**: Real time data obtained from the leading news resource [News API](https://newsapi.org/) -Runs the app in the development mode.
-Open [http://localhost:3000](http://localhost:3000) to view it in the browser. +- 📱 **Responsive**: Made mobile responsive with CSS Grid and Flexbox -The page will reload if you make edits.
-You will also see any lint errors in the console. +- 🔥 **Live**: Deployed with [GitHub Pages](https://pages.github.com/) -### `npm 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. - -### `npm run build` - -Builds the app for production to the `build` folder.
-It correctly bundles React in production mode and optimizes the build for the best performance. - -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. - -### `npm run 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. - -## 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/). - -### Code Splitting - -This section has moved here: https://facebook.github.io/create-react-app/docs/code-splitting - -### Analyzing the Bundle Size - -This section has moved here: https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size - -### Making a Progressive Web App - -This section has moved here: https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app - -### Advanced Configuration - -This section has moved here: https://facebook.github.io/create-react-app/docs/advanced-configuration - -### Deployment - -This section has moved here: https://facebook.github.io/create-react-app/docs/deployment - -### `npm run build` fails to minify - -This section has moved here: https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify +## Demo +[Launch App](https://alsherko.github.io/news-api-react/) \ No newline at end of file