Skip to content

Commit 63ea0fe

Browse files
Update README.md with updated installation instructions and info about the website.
1 parent fd01adf commit 63ea0fe

File tree

2 files changed

+26
-7
lines changed

2 files changed

+26
-7
lines changed

.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
.DS_Store
22
/target
3+
/dist
34
TODO

README.md

+25-7
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
![jless logo and mascot](https://raw.githubusercontent.com/PaulJuliusMartinez/jless/master/logo/text-logo-with-mascot.svg)
22

3-
[`jless`](https://pauljuliusmartinez.github.io/jless/) is a command-line
4-
JSON viewer. Use it as a replacement for whatever combination of `less`,
5-
`jq`, `cat` and your editor you currently use for viewing JSON files. It
6-
is written in Rust and can be installed as a single standalone binary.
3+
[`jless`](https://jless.io) is a command-line JSON viewer. Use it as a
4+
replacement for whatever combination of `less`, `jq`, `cat` and your
5+
editor you currently use for viewing JSON files. It is written in Rust
6+
and can be installed as a single standalone binary.
77

88
`jless` is under active development. I often stream development live on
99
[Twitch](https://twitch.tv/CodeIsTheEnd).
@@ -25,15 +25,33 @@ is written in Rust and can be installed as a single standalone binary.
2525

2626
## Installation
2727

28+
You can install `jless` using various package managers:
29+
30+
| Operating System / Package Manager | Command |
31+
| ---------------------------------- | ------- |
32+
| macOS - [HomeBrew](https://formulae.brew.sh/formula/jless) | `brew install jless` |
33+
| macOS - [MacPorts](https://ports.macports.org/port/jless/) | `sudo port install jless` |
34+
| Linux - [HomeBrew](https://formulae.brew.sh/formula/jless) | `brew install jless` |
35+
| [Arch Linux](https://aur.archlinux.org/packages/jless) | `pacman -U jless` |
36+
| [NetBSD](https://pkgsrc.se/textproc/jless/) | `pkgin install jless` |
37+
38+
If you have a Rust toolchain installed, you can install `jless` from
39+
source by running `cargo install jless`.
40+
2841
The [releases](https://github.com/PaulJuliusMartinez/jless/releases)
29-
contains links to the latest release. If you have a Rust toolchain
30-
installed, you can build from source by running `cargo install jless`.
42+
page also contains links to binaries for various architectures.
43+
44+
## Website
45+
46+
[jless.io](https://jless.io) is the official website for `jless`. Code
47+
for the website is contained separately on the
48+
[`website`](https://github.com/PaulJuliusMartinez/jless/tree/website) branch.
3149

3250
## Logo
3351

3452
The mascot of the `jless` project is Jules the jellyfish.
3553

36-
<img style="width: 300px;" alt="jless mascot" src="https://raw.githubusercontent.com/PaulJuliusMartinez/jless/master/logo/mascot.svg">
54+
<img style="width: 250px;" alt="jless mascot" src="https://raw.githubusercontent.com/PaulJuliusMartinez/jless/master/logo/mascot.svg">
3755

3856
Art for Jules was created by
3957
[`annatgraphics`](https://www.fiverr.com/annatgraphics).

0 commit comments

Comments
 (0)