From dd7aebaf944a90d4abd96aa8059ba6834907cc3d Mon Sep 17 00:00:00 2001 From: liyasthomas Date: Wed, 5 Jan 2022 09:37:13 +0530 Subject: [PATCH] docs: update readme --- README.md | 53 ++++++++++++++++++++++++++--------------------------- 1 file changed, 26 insertions(+), 27 deletions(-) diff --git a/README.md b/README.md index 9173dd690..8ae47ed84 100644 --- a/README.md +++ b/README.md @@ -89,13 +89,13 @@ - `TRACE` - Performs a message loop-back test along the path to the target resource - `` - Some APIs use custom request methods such as `LIST`. Type in your custom methods. -🌈 **Make it yours:** Customizable combinations for background, foreground and accent colors — [customize now](https://hoppscotch.io/settings). +🌈 **Make it yours:** Customizable combinations for background, foreground, and accent colors — [customize now](https://hoppscotch.io/settings). **Theming** -- Choose theme: System (default), Light, Dark and Black -- Choose accent color: Green (default), Teal, Blue, Indigo, Purple, Yellow, Orange, Red and Pink -- Distraction free Zen mode +- Choose a theme: System (default), Light, Dark, and Black +- Choose accent color: Green (default), Teal, Blue, Indigo, Purple, Yellow, Orange, Red, and Pink +- Distraction-free Zen mode _Customized themes are synced with cloud / local session_ @@ -120,11 +120,11 @@ _Customized themes are synced with cloud / local session_ 🔌 **WebSocket:** Establish full-duplex communication channels over a single TCP connection. -📡 **Server Sent Events:** Receive a stream of updates from a server over a HTTP connection without resorting to polling. +📡 **Server-Sent Events:** Receive a stream of updates from a server over an HTTP connection without resorting to polling. 🌩 **Socket.IO:** Send and Receive data with SocketIO server. -🦟 **MQTT:** Subscribe and Publish to topics of a MQTT Broker. +🦟 **MQTT:** Subscribe and Publish to topics of an MQTT Broker. 🔮 **GraphQL:** GraphQL is a query language for APIs and a runtime for fulfilling those queries with your existing data. @@ -134,7 +134,7 @@ _Customized themes are synced with cloud / local session_ - Query schema - Get query response -🔐 **Authorization:** Allows to identify the end user. +🔐 **Authorization:** Allows to identify the end-user. - None - Basic @@ -149,10 +149,10 @@ _Customized themes are synced with cloud / local session_ 📃 **Request Body:** Used to send and receive data via the REST API. - Set `Content Type` -- FormData, JSON and many more +- FormData, JSON, and many more - Toggle between key-value and RAW input parameter list -👋 **Response:** Contains the status line, headers and the message/response body. +👋 **Response:** Contains the status line, headers, and the message/response body. - Copy response to clipboard - Download response as a file @@ -163,22 +163,22 @@ _Customized themes are synced with cloud / local session_ 📁 **Collections:** Keep your API requests organized with collections and folders. Reuse them with a single click. -- Unlimited collections, folders and requests +- Unlimited collections, folders, and requests - Nested folders -- Export and import as file or GitHub gist +- Export and import as a file or GitHub gist _Collections are synced with cloud / local session storage_ 🌐 **Proxy:** Enable Proxy Mode from Settings to access blocked APIs. - Hide your IP address -- Fixes [`CORS`](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) (Cross Origin Resource Sharing) issues +- Fixes [`CORS`](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) (Cross-Origin Resource Sharing) issues - Access APIs served in non-HTTPS (`http://`) endpoints -- Use your own Proxy URL +- Use your Proxy URL _Official proxy server is hosted by Hoppscotch - **[GitHub](https://github.com/hoppscotch/proxyscotch)** - **[Privacy Policy](https://docs.hoppscotch.io/privacy)**_ -📜 **Pre-Request Scripts β:** Snippets of code associated with a request that are executed before the request is sent. +📜 **Pre-Request Scripts β:** Snippets of code associated with a request that is executed before the request is sent. - Set environment variables - Include timestamp in the request headers @@ -195,7 +195,7 @@ _Official proxy server is hosted by Hoppscotch - **[GitHub](https://github.com/h > **[Read our documentation on Keyboard Shortcuts](https://docs.hoppscotch.io/features/shortcuts)** -🌎 **i18n:** Experience the app in your own language. +🌎 **i18n:** Experience the app in your language. Help us to translate Hoppscotch. Please read [`TRANSLATIONS`](TRANSLATIONS.md) for details on our [`CODE OF CONDUCT`](CODE_OF_CONDUCT.md), and the process for submitting pull requests to us. @@ -228,7 +228,7 @@ _Add-ons are developed and maintained under **[Hoppscotch Organization](https:// - Environments - Settings -✅ **Post-Request Tests β:** Write tests associated with a request that are executed after the request response. +✅ **Post-Request Tests β:** Write tests associated with a request that is executed after the request's response. - Check the status code as an integer - Filter response headers @@ -238,7 +238,7 @@ _Add-ons are developed and maintained under **[Hoppscotch Organization](https:// 🌱 **Environments** : Environment variables allow you to store and reuse values in your requests and scripts. - Unlimited environments and variables -- Initialize through pre-request script +- Initialize through the pre-request script - Export as / import from GitHub gist
@@ -277,10 +277,9 @@ _Add-ons are developed and maintained under **[Hoppscotch Organization](https:// ## **Usage** -1. Choose `method` -2. Enter `URL` -3. Send request -4. Get response +1. Provide your API endpoint in the URL field +2. CLick "Send" to simulate the request +3. View the response ## **Built with** @@ -295,9 +294,9 @@ _Add-ons are developed and maintained under **[Hoppscotch Organization](https:// 0. Update [`.env.example`](https://github.com/hoppscotch/hoppscotch/blob/main/packages/hoppscotch-app/.env.example) file found in `packages/hoppscotch-app` with your own keys and rename it to `.env`. -_Sample keys only works with the [production build](https://hoppscotch.io)._ +_Sample keys only work with the [production build](https://hoppscotch.io)._ -### Browser based development environment +### Browser-based development environment - [GitHub codespace](https://docs.github.com/en/codespaces/developing-in-codespaces/creating-a-codespace) - [Gitpod](https://gitpod.io/#https://github.com/hoppscotch/hoppscotch) @@ -308,13 +307,13 @@ _Sample keys only works with the [production build](https://hoppscotch.io)._ 2. Install pnpm using npm by running `npm install -g pnpm`. 3. Install dependencies by running `pnpm install` within the directory that you cloned (probably `hoppscotch`). 4. Start the development server with `pnpm run dev`. -5. Open development site by going to [`http://localhost:3000`](http://localhost:3000) in your browser. +5. Open the development site by going to [`http://localhost:3000`](http://localhost:3000) in your browser. ### Docker compose 1. [Clone this repo](https://help.github.com/en/articles/cloning-a-repository) with git. -2. Run `docker-compose up` -3. Open development site by going to [`http://localhost:3000`](http://localhost:3000) in your browser. +2. Run `docker-compose up` within the directory that you cloned (probably `hoppscotch`). +3. Open the development site by going to [`http://localhost:3000`](http://localhost:3000) in your browser. ## **Docker** @@ -348,7 +347,7 @@ See the [`CHANGELOG`](CHANGELOG.md) file for details. ## **Authors** -This project exists thanks to all the people who contribute — [make a contribution](CONTRIBUTING.md). +This project exists thanks to all the people who contribute — [contribute](CONTRIBUTING.md).