✏️ Updated links
This commit is contained in:
37
README.md
37
README.md
@@ -5,9 +5,9 @@ When I wrote this, only God and I understood what I was doing. Now, only God kno
|
|||||||
<div align="center">
|
<div align="center">
|
||||||
<a href="https://liyas-thomas.firebaseapp.com"><img src="static/icons/logo.svg" alt="Liyas Thomas" height="128"></a>
|
<a href="https://liyas-thomas.firebaseapp.com"><img src="static/icons/logo.svg" alt="Liyas Thomas" height="128"></a>
|
||||||
<br>
|
<br>
|
||||||
<h1><a href="https://postwoman.io">Postwoman</a></h1>
|
<h1><a href="https://postwoman.io">Postwoman.io</a></h1>
|
||||||
<p>
|
<p>
|
||||||
API request builder - Helps you create your requests faster, saving you precious time on your development. <a href="https://postwoman.launchaco.com">Subscribe for updates</a>
|
API request builder - Helps you create your requests faster, saving you precious time on your development - <a href="https://postwoman.launchaco.com">Subscribe for updates</a>
|
||||||
</p>
|
</p>
|
||||||
<p>
|
<p>
|
||||||
|
|
||||||
@@ -26,7 +26,7 @@ When I wrote this, only God and I understood what I was doing. Now, only God kno
|
|||||||
|
|
||||||
**Chat here: _[Telegram](https://t.me/postwoman_app), [Discord](https://discord.gg/GAMWxmR)_**
|
**Chat here: _[Telegram](https://t.me/postwoman_app), [Discord](https://discord.gg/GAMWxmR)_**
|
||||||
|
|
||||||
**Donate here: _[PayPal](https://www.paypal.me/liyascthomas), [Buy me a coffee](https://www.buymeacoffee.com/liyasthomas)_**
|
**Donate here: _[PayPal](https://www.paypal.me/liyascthomas), [Open Collective](https://opencollective.com/postwoman), [Buy me a coffee](https://www.buymeacoffee.com/liyasthomas)_**
|
||||||
|
|
||||||
<div align="center">
|
<div align="center">
|
||||||
<br>
|
<br>
|
||||||
@@ -34,13 +34,13 @@ When I wrote this, only God and I understood what I was doing. Now, only God kno
|
|||||||
<br>
|
<br>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
### Features :sparkles:
|
### Features ✨
|
||||||
|
|
||||||
:heart: **Lightweight**: Crafted with minimalistic UI design
|
❤️ **Lightweight**: Crafted with minimalistic UI design
|
||||||
|
|
||||||
- Faster, lighter, cleaner, minimal & responsive
|
- Faster, lighter, cleaner, minimal & responsive
|
||||||
|
|
||||||
:zap: **Real-time**: Send requests and get/copy responses right away!
|
⚡️ **Real-time**: Send requests and get/copy responses right away!
|
||||||
|
|
||||||
**Methods:**
|
**Methods:**
|
||||||
- `GET` - Retrieve information about the REST API resource
|
- `GET` - Retrieve information about the REST API resource
|
||||||
@@ -53,7 +53,7 @@ When I wrote this, only God and I understood what I was doing. Now, only God kno
|
|||||||
|
|
||||||
_History entries are synced with local session storage_
|
_History entries are synced with local session storage_
|
||||||
|
|
||||||
:rainbow: **VIBGYOR**: Neon combination background, foreground & accent colors - because customization === freedom :sparkles:
|
🌈 **Make it yours**: Neon combination background, foreground & accent colors - because customization === freedom ✨
|
||||||
|
|
||||||
**Customizations:**
|
**Customizations:**
|
||||||
- Dark and Light background themes
|
- Dark and Light background themes
|
||||||
@@ -62,14 +62,14 @@ _History entries are synced with local session storage_
|
|||||||
|
|
||||||
_Customized themes are also synced with local session storage_
|
_Customized themes are also synced with local session storage_
|
||||||
|
|
||||||
:fire: **PWA**: Install as a **[PWA](https://developers.google.com/web/progressive-web-apps)** on your device
|
🔥 **PWA**: Install as a **[PWA](https://developers.google.com/web/progressive-web-apps)** on your device
|
||||||
|
|
||||||
**Features:**
|
**Features:**
|
||||||
- Instant loading with Service Workers
|
- Instant loading with Service Workers
|
||||||
- Offline support
|
- Offline support
|
||||||
- Low RAM/memory and CPU usage
|
- Low RAM/memory and CPU usage
|
||||||
|
|
||||||
:rocket: **Request**: Retrieve data from a URL without having to do a full page refresh
|
🚀 **Request**: Retrieve data from a URL without having to do a full page refresh
|
||||||
|
|
||||||
- Choose `method`
|
- Choose `method`
|
||||||
- Enter `URL`
|
- Enter `URL`
|
||||||
@@ -79,35 +79,35 @@ _Customized themes are also synced with local session storage_
|
|||||||
- Copy generated request code to clipboard
|
- Copy generated request code to clipboard
|
||||||
- Import cURL
|
- Import cURL
|
||||||
|
|
||||||
:electric_plug: **Web Socket**: Establish full-duplex communication channels over a single TCP connection
|
🔌 **Web Socket**: Establish full-duplex communication channels over a single TCP connection
|
||||||
|
|
||||||
- Send and receive data
|
- Send and receive data
|
||||||
|
|
||||||
:closed_lock_with_key: **Authentication**: Allows to identity the end user
|
🔐 **Authentication**: Allows to identity the end user
|
||||||
|
|
||||||
**Types:**
|
**Types:**
|
||||||
- None
|
- None
|
||||||
- Basic authentication using username and password
|
- Basic authentication using username and password
|
||||||
- Token based authentication
|
- Token based authentication
|
||||||
|
|
||||||
:loudspeaker: **Headers**: Describes the format the body of your request is being sent as
|
📢 **Headers**: Describes the format the body of your request is being sent as
|
||||||
|
|
||||||
:mailbox: **Parameters**: Use request parameters to set varying parts in simulated requests
|
📫 **Parameters**: Use request parameters to set varying parts in simulated requests
|
||||||
|
|
||||||
:page_with_curl: **Request Body**: Used to send and receive data via the REST API
|
📃 **Request Body**: Used to send and receive data via the REST API
|
||||||
|
|
||||||
**Options:**
|
**Options:**
|
||||||
- Set Content Type
|
- Set Content Type
|
||||||
- Toggle between RAW input and parameter list
|
- Toggle between RAW input and parameter list
|
||||||
|
|
||||||
:wave: **Responses**: Contains the status line, headers and the message/response body
|
👋 **Responses**: Contains the status line, headers and the message/response body
|
||||||
|
|
||||||
- Copy response to clipboard
|
- Copy response to clipboard
|
||||||
- View preview for HTML responses
|
- View preview for HTML responses
|
||||||
|
|
||||||
_HTML responses have "Preview HTML" feature_
|
_HTML responses have "Preview HTML" feature_
|
||||||
|
|
||||||
:alarm_clock: **History**: Request entries are synced with local session storage to reuse with a single click
|
⏰ **History**: Request entries are synced with local session storage to reuse with a single click
|
||||||
|
|
||||||
**Fields**
|
**Fields**
|
||||||
- Timestamp
|
- Timestamp
|
||||||
@@ -167,7 +167,7 @@ docker run -p 3000:3000 liyasthomas/postwoman:latest
|
|||||||
docker build -t postwoman:latest
|
docker build -t postwoman:latest
|
||||||
```
|
```
|
||||||
|
|
||||||
## Releasing 🔖
|
## Releasing 🏷️
|
||||||
|
|
||||||
1. [Clone this repo](https://help.github.com/en/articles/cloning-a-repository) with git.
|
1. [Clone this repo](https://help.github.com/en/articles/cloning-a-repository) with git.
|
||||||
1. Install dependencies by running `npm install` within the directory that you cloned (probably `postwoman`).
|
1. Install dependencies by running `npm install` within the directory that you cloned (probably `postwoman`).
|
||||||
@@ -229,6 +229,7 @@ See the list of [contributors](https://github.com/liyasthomas/postwoman/graphs/c
|
|||||||
### Code Contributors
|
### Code Contributors
|
||||||
|
|
||||||
This project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)].
|
This project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)].
|
||||||
|
|
||||||
<a href="https://github.com/liyasthomas/postwoman/graphs/contributors"><img src="https://opencollective.com/postwoman/contributors.svg?width=890&button=false" /></a>
|
<a href="https://github.com/liyasthomas/postwoman/graphs/contributors"><img src="https://opencollective.com/postwoman/contributors.svg?width=890&button=false" /></a>
|
||||||
|
|
||||||
### Financial Contributors
|
### Financial Contributors
|
||||||
@@ -237,7 +238,7 @@ Become a financial contributor and help us sustain our community. [[Contribute](
|
|||||||
|
|
||||||
#### Individuals
|
#### Individuals
|
||||||
|
|
||||||
<a href="https://opencollective.com/postwoman"><img src="https://opencollective.com/postwoman/individuals.svg?width=890"></a>
|
<a href="https://opencollective.com/postwoman"><img src="https://opencollective.com/postwoman/individuals.svg"></a>
|
||||||
|
|
||||||
#### Organizations
|
#### Organizations
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user