Skip to content

Commit 9183a8d

Browse files
docs: Update README with shields and macOS installation info
1 parent d629c48 commit 9183a8d

File tree

1 file changed

+18
-14
lines changed

1 file changed

+18
-14
lines changed

README.md

+18-14
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,14 @@
11
# facad
22

3+
[![Documentation](https://img.shields.io/badge/documentation-awesome-f5b836.svg?style=flat-square)](https://yellow-footed-honeyguide.github.io/facad/)
4+
[![versions](https://img.shields.io/repology/repositories/facad?style=flat-square&color=f5b836)](https://repology.org/project/facad/versions)
5+
[![Homebrew](https://img.shields.io/homebrew/installs/dy/facad?style=flat-square&color=f5b836&label=homebrew%20installs)](https://formulae.brew.sh/formula/facad)
6+
37
A modern, colorful directory listing tool for the command line.
48

59
![facad in action](assets/facad_2_18.jpg)
610

11+
712
## Features
813
> Designed for both novice users and power users,<br>
914
> facad feature set aims to enhance file management experience with<br>
@@ -21,37 +26,36 @@ A modern, colorful directory listing tool for the command line.
2126
### Dependencies
2227
- Pure C implementation without any dependency
2328

29+
### macOS
30+
facad is available through Homebrew. To install, run:
31+
```bash
32+
brew install facad
33+
```
34+
2435
### I use Arch btw?
2536
Just use the script from AUR:
2637
```bash
2738
yay -S facad
2839
```
2940

30-
### Build
41+
### Build & Install from source
3142
```bash
3243
git clone https://github.com/yellow-footed-honeyguide/facad.git
3344
cd facad
3445
mkdir build && cd build
3546
meson setup .. && ninja
36-
```
37-
38-
### Install
39-
For system-wide installation (may require elevated privileges like `sudo`):
40-
```bash
47+
# for system-wide installation (may require elevated privileges like `sudo`):
4148
sudo ninja install
4249
```
4350

4451
## Usage
4552

46-
Run `facad` command for default grid file listing
47-
48-
Run `facad -l` command for long listing output
49-
50-
Run `facad -a` command for dir analytics output
51-
52-
Run `facad -h` command for help
53+
Run `facad` command for default grid file listing<br>
54+
Run `facad -h/--help` command for help<br>
55+
Run `facad -v--version` command for version<br>
56+
Run `facad -l/--long` command for long listing output<br>
57+
Run `facad -a/--analytics` command for dir analytics output
5358

54-
Run `facad -v` command for version
5559

5660

5761
## Contributing

0 commit comments

Comments
 (0)