Skip to content

Commit 7d97c9e

Browse files
committed
docs: Cleanup readme
1 parent 97367e8 commit 7d97c9e

File tree

1 file changed

+15
-17
lines changed

1 file changed

+15
-17
lines changed

README.md

Lines changed: 15 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# basalt
22

3-
`basalt` is the ultimate Bash (and Zsh, Fish, etc.) Package Manager
3+
The rock-solid Bash package manager
44

55
STATUS: BETA (expect breaking changes until a post-beta release)
66

@@ -18,39 +18,37 @@ This symlinks all executable scripts to a common directory. It does this for com
1818

1919
```sh
2020
$ exa -l --no-permissions --no-filesize --no-user ~/.local/share/basalt/global/bin/
21-
bash2048.sh -> /home/edwin/.local/share/basalt/store/packages/github.com/JosefZIla/bash2048/bash2048.sh
22-
bashtop -> /home/edwin/.local/share/basalt/store/packages/github.com/aristocratos/bashtop/bashtop
23-
git-alias -> /home/edwin/.local/share/basalt/store/packages/github.com/tj/git-extras/bin/git-alias
24-
git-archive-file -> /home/edwin/.local/share/basalt/store/packages/github.com/tj/git-extras/bin/git-archive-file
21+
bash2048.sh -> .../.local/share/basalt/store/packages/github.com/JosefZIla/bash2048@.../bash2048.sh
22+
bashtop -> .../.local/share/basalt/store/packages/github.com/aristocratos/bashtop@.../bashtop
23+
git-alias -> .../.local/share/basalt/store/packages/github.com/tj/git-extras@.../bin/git-alias
24+
git-archive-file -> .../.local/share/basalt/store/packages/github.com/tj/git-extras@.../bin/git-archive-file
2525
...
2626
```
2727

28-
To be able to access the binaries, completion files, and man pages in your shell, simply add a two-liner in your shell configuration
28+
To be able to access the binaries, completion files, and man pages in your shell, simply add a two-liner in your shell configuration. The [installation script](./scripts/install.sh) already does this for you
2929

3030
```sh
3131
# ~/.bashrc
3232
export PATH="${XDG_DATA_HOME:-$HOME/.local/share}/basalt/source/pkg/bin:$PATH"
3333
eval "$(basalt global init bash)" # zsh and fish are also supported
3434
```
3535

36-
See [Installation](./docs/tutorials/installation.md) and [Getting Started](./docs/tutorials/getting-started.md) for more details
36+
***NOTE***: Basalt is currently BETA. There are known bugs that will be fixed. I _highly_ recommended to wait until `v1.0.0` before trying anything out
3737

38+
See [Installation](./docs/tutorials/installation.md) and [Getting Started](./docs/tutorials/getting-started.md) for more details
3839

3940
## Features
4041

41-
Note that many of these features have been implemented before, but require a reimplementation since the major rewrite
42-
43-
- [x] Lockfile usage
44-
- [ ] Transaction rollback
45-
- [ ] Works with essentially all popular Bash projects out of the box
46-
- [ ] Specifying specific man, completion, etc. directories
47-
- [x] Local package installation
48-
- [x] Global (user-wide) package installation
49-
- [ ] Custom builtins
42+
- Install most Bash/Zsh/Fish projects out of the box
43+
- Local Bash packages (Awk/Zsh/Fish/Ksh coming later)
44+
- Custom builtins for packages (not yet implemented)
45+
- Robust (lockfile usage, transaction rollback (not yet implemented), great error handling)
5046

5147
## Ecosystem
5248

53-
There is a small, but growing number of packages installable with Basalt. See the list at [awesome-bash-packages](https://github.com/hyperupcall/awesome-bash-packages)
49+
Most of the "ecosystem" is just good utility libraries and somewhat useful Bash applications I've made
50+
51+
See the list at [awesome-bash-packages](https://github.com/hyperupcall/awesome-bash-packages)
5452

5553
## License
5654

0 commit comments

Comments
 (0)