Skip to content

Commit

Permalink
Updating docs
Browse files Browse the repository at this point in the history
  • Loading branch information
darrenburns committed Aug 17, 2024
1 parent 34e261a commit 93c4c66
Show file tree
Hide file tree
Showing 5 changed files with 51 additions and 22 deletions.
15 changes: 14 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,20 @@ pipx install posting
rye install posting
```

Both of these methods will install Posting in an isolated environment.
### Rye is recommended

Rye is recommended, as it is significantly faster than Homebrew and `pipx`, and can install Posting in under a second.

```bash
# quick install on MacOS/Linux
curl -sSf https://rye.astral.sh/get | bash

# install Posting
rye install posting
```

Windows users should follow the guide [Rye](https://rye-up.com/guide/installation) to learn how to install Rye.


## Learn More

Expand Down
29 changes: 20 additions & 9 deletions docs/guide/index.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,36 @@
## Installation

Posting can be installed via [Rye](https://rye-up.com/guide/installation) or [`pipx`](https://pipx.pypa.io/stable/) on MacOS, Linux, and Windows.
Posting can be installed in a matter of seconds on MacOS, Linux, and Windows.

### Rye (recommended)

Rye is recommended, as it is faster than Homebrew and `pipx` by several orders of magnitude:

```bash
curl -sSf https://rye.astral.sh/get | bash # install if needed
# Install Rye (on MacOS/Linux only - Windows users see below)
curl -sSf https://rye.astral.sh/get | bash

# install Posting
rye install posting
```

Alternatively, you can install Posting via `pipx`.
Windows users should follow the guide [Rye](https://rye-up.com/guide/installation) to learn how to install Rye.

### pipx

If you prefer, you can install Posting via [`pipx`](https://pipx.pypa.io/stable/).

```bash
pipx install posting
```

### Homebrew?
---

The methods above will both install Posting globally, in an isolated environment. Do *not* attempt to install Posting with `pip`.

??? failure "Homebrew is not supported"

Installing via Homebrew is not supported, as some of Posting's Rust and C dependencies can take over 10 minutes to compile. When using Rye, installation time is measured in tens of milliseconds, and with `pipx` it's just a few seconds.
Installing via Homebrew is not supported, as some of Posting's Rust and C dependencies can take over 10 minutes to compile. When using Rye, installation time is measured in tens of milliseconds, and with `pipx` it's just a few seconds.

<!--
On MacOS, you can also install Posting via Homebrew:
Expand Down Expand Up @@ -52,11 +65,9 @@ Now, any requests you create will be saved in the `my-collection` directory as s

### Creating a request

When you launch Posting, no request is open.
When you launch Posting, no request is open, so the UI will look rather empty.

You can immediately start creating a request, and then save it to disk with ++ctrl+s++.
Let's do just that.
We'll create a simple POST request to the [JSONPlaceholder](https://jsonplaceholder.typicode.com/) mock API to create a new user.
Let's create a simple POST request to the [JSONPlaceholder](https://jsonplaceholder.typicode.com/) mock API to create a new user.

Press ++ctrl+t++ to open the request method dropdown, then press ++p++ to quickly select the `POST` method.

Expand Down
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,7 @@ markdown_extensions:
- pymdownx.highlight:
use_pygments: true
- pymdownx.superfences
- pymdownx.details
extra:
social:
- icon: fontawesome/brands/mastodon
Expand Down
23 changes: 13 additions & 10 deletions requirements-dev.lock
Original file line number Diff line number Diff line change
Expand Up @@ -7,23 +7,26 @@
# all-features: false
# with-sources: false
# generate-hashes: false
# universal: false

-e file:.
aiohttp==3.9.5
aiohappyeyeballs==2.3.6
# via aiohttp
aiohttp==3.10.3
# via textual-dev
aiosignal==1.3.1
# via aiohttp
annotated-types==0.7.0
# via pydantic
anyio==4.4.0
# via httpx
attrs==23.2.0
attrs==24.2.0
# via aiohttp
babel==2.15.0
babel==2.16.0
# via mkdocs-material
brotli==1.1.0
# via httpx
certifi==2024.2.2
certifi==2024.7.4
# via httpcore
# via httpx
# via requests
Expand All @@ -38,7 +41,7 @@ click-default-group==1.2.4
# via posting
colorama==0.4.6
# via mkdocs-material
coverage==7.6.0
coverage==7.6.1
# via pytest-cov
execnet==2.1.1
# via pytest-xdist
Expand Down Expand Up @@ -66,7 +69,7 @@ jinja2==3.1.4
# via pytest-textual-snapshot
linkify-it-py==2.0.3
# via markdown-it-py
markdown==3.6
markdown==3.7
# via mkdocs
# via mkdocs-material
# via pymdown-extensions
Expand All @@ -88,7 +91,7 @@ mkdocs==1.6.0
# via mkdocs-material
mkdocs-get-deps==0.2.0
# via mkdocs
mkdocs-material==9.5.30
mkdocs-material==9.5.31
mkdocs-material-extensions==1.3.1
# via mkdocs-material
msgpack==1.0.8
Expand Down Expand Up @@ -121,7 +124,7 @@ pymdown-extensions==10.9
# via mkdocs-material
pyperclip==1.8.2
# via posting
pytest==8.3.1
pytest==8.3.2
# via pytest-cov
# via pytest-textual-snapshot
# via pytest-xdist
Expand Down Expand Up @@ -169,7 +172,7 @@ tree-sitter==0.20.4
# via tree-sitter-languages
tree-sitter-languages==1.10.2
# via textual
typing-extensions==4.12.0
typing-extensions==4.12.2
# via pydantic
# via pydantic-core
# via textual
Expand All @@ -179,7 +182,7 @@ uc-micro-py==1.0.3
# via linkify-it-py
urllib3==2.2.2
# via requests
watchdog==4.0.1
watchdog==4.0.2
# via mkdocs
xdg-base-dirs==6.0.1
# via posting
Expand Down
5 changes: 3 additions & 2 deletions requirements.lock
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
# all-features: false
# with-sources: false
# generate-hashes: false
# universal: false

-e file:.
annotated-types==0.7.0
Expand All @@ -15,7 +16,7 @@ anyio==4.4.0
# via httpx
brotli==1.1.0
# via httpx
certifi==2024.2.2
certifi==2024.7.4
# via httpcore
# via httpx
click==8.1.7
Expand Down Expand Up @@ -73,7 +74,7 @@ tree-sitter==0.20.4
# via tree-sitter-languages
tree-sitter-languages==1.10.2
# via textual
typing-extensions==4.12.0
typing-extensions==4.12.2
# via pydantic
# via pydantic-core
# via textual
Expand Down

0 comments on commit 93c4c66

Please sign in to comment.