Skip to content

Commit a27bc73

Browse files
Merge pull request #85 from californiakat/patch-1
Correct typos in README.md
2 parents e32e42b + df8fdbe commit a27bc73

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,24 +2,24 @@
22

33
[![Click](https://img.shields.io/badge/Click-Liquid%20%20Prep%20App-blue)](https://liquid-prep-app.s3-web.us-east.cloud-object-storage.appdomain.cloud/)
44

5-
Liquid Prep App is an user interface that is accessed on your mobile device to get water advise for the selected crop. It is a [Progressive Web App (PWA)](https://web.dev/progressive-web-apps/) developed with [Angular](https://angular.io/) web framework.
5+
The Liquid Prep App is a user interface that is accessed on your mobile device to receive watering guidance for a selected crop. It is a [progressive web app (PWA)](https://web.dev/progressive-web-apps/) developed with an [Angular](https://angular.io/) web framework.
66

7-
The Liquid Prep App gets the Weather and Crops data from the [Liquid Prep Backend](https://github.com/Liquid-Prep/LiquidPrep-Backend) service and the soil moisture data from the [Liquid Prep Hardware](https://github.com/Liquid-Prep/LiquidPrep-Hardware). After analysis of the weather, crop and soil moisture data the app computes and provides water advise for the selected crop.
7+
The app gets weather and crops data from the [Liquid Prep Backend](https://github.com/Liquid-Prep/LiquidPrep-Backend) service, and the soil moisture data from the [Liquid Prep Hardware](https://github.com/Liquid-Prep/LiquidPrep-Hardware). After the analysis of weather, crop and soil moisture data, the app computes and provides water advice for your crop.
88

9-
The Liquid Prep App can be run on your local machine for development and testing purpose. And it is deployed on [IBM Cloud Object Storage](https://www.ibm.com/ca-en/cloud/object-storage) for production to be accessed globally.
9+
The Liquid Prep App can be run on your local machine for development and testing purposes, and is deployed on [IBM Cloud Object Storage](https://www.ibm.com/ca-en/cloud/object-storage) for production to be accessed globally.
1010

1111
**[Click to access Liquid Prep App](https://liquid-prep-app.s3-web.us-east.cloud-object-storage.appdomain.cloud/)**
1212

1313
## Get Started
1414

15-
Instructions on how to run the App,
15+
Instructions on how to run the app:
1616

17-
- [Pre-requisites](#pre-requisites)
17+
- [Prerequisites](#pre-requisites)
1818
- [Run App Locally](#run-app-locally)
19-
- [Configure and Deploy App in IBM Cloud Object Storage](#configure-and-deploy-app-in-ibm-cloud-object-storage)
19+
- [Configure and Deploy in IBM Cloud Object Storage](#configure-and-deploy-app-in-ibm-cloud-object-storage)
2020
- [Contributing](#contributing)
2121

22-
### Pre-requisites
22+
### Prerequisites
2323

2424
1. Node and NPM:
2525
- [Install Node and NPM](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)
@@ -30,7 +30,7 @@ Instructions on how to run the App,
3030
- [Configure Git](https://git-scm.com/book/en/v2/Getting-Started-First-Time-Git-Setup)
3131
- [Git account setup and configuration](https://git-scm.com/book/en/v2/GitHub-Account-Setup-and-Configuration)
3232
4. Liquid Prep project:
33-
- [Git clone Liquid Prep project](https://github.com/Liquid-Prep/Liquid-Prep)
33+
- [Git-clone Liquid Prep project](https://github.com/Liquid-Prep/Liquid-Prep)
3434
5. IBM Cloud account:
3535
- [Create an IBM Cloud account](https://cloud.ibm.com/registration)
3636
6. Liquid Prep Backend Service Endpoint:
@@ -53,17 +53,17 @@ Instructions on how to run the App,
5353
- Run `npm start`.
5454
- Open the browser and enter `http://localhost:4200/`. The app will automatically reload if you change any of the source files.
5555

56-
**NOTE:** You can also run the App by executing Angular CLI command `ng serve` too.
56+
**Note:** You can also run the app by executing Angular CLI command `ng serve`.
5757

5858
### Configure and Deploy the App in IBM Cloud Object Storage
5959

60-
The Liquid Prep App can be built and deployed in production for accessing the endpoint URL in any browser (recommended Chrome) to spin up the App in the browser.
60+
The Liquid Prep App can be built and deployed in production for accessing the endpoint URL in any browser (we recommend Chrome).
6161

62-
Please follow the step wise instructions in the [IBM Cloud Deployment Documentation](IBM-CLOUD-SETUP.md).
62+
Follow the stepwise instructions in the [IBM Cloud Deployment Documentation](IBM-CLOUD-SETUP.md).
6363

6464
## Contributing
6565

66-
Please read [CONTRIBUTING.md](https://github.com/Liquid-Prep/Liquid-Prep/blob/main/CONTRIBUTING.md) for details on our code of conduct, areas where we'd like to see community contributions, and the process for submitting pull requests to the project.
66+
For details on our code of conduct, areas where we'd like to see community contributions, and the process for submitting pull requests to the project, see Please read [CONTRIBUTING.md](https://github.com/Liquid-Prep/Liquid-Prep/blob/main/CONTRIBUTING.md).
6767

6868
## License
6969

0 commit comments

Comments
 (0)