Skip to content

Commit

Permalink
docs: add badges and TODOs
Browse files Browse the repository at this point in the history
  • Loading branch information
mvprowess committed Aug 18, 2024
1 parent bded3b4 commit d033e45
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
# BASH Library <img src="https://raw.githubusercontent.com/fmjstudios/artwork/main/projects/bashlib/icon/bash-icon-color.png" alt="Bash Logo" align="right" width="225"/>

[![GitHub top language](https://img.shields.io/github/languages/top/fmjstudios/bashlib)](https://www.gnu.org/software/bash/)
[![GitHub License](https://img.shields.io/github/license/fmjstudios/bashlib?label=License)](https://opensource.org/license/mit)
[![GitHub Tag](https://img.shields.io/github/v/tag/fmjstudios/bashlib?label=Version)](https://github.com/fmjstudios/bashlib/releases)
[![Continuous Integration](https://github.com/fmjstudios/bashlib/actions/workflows/ci.yaml/badge.svg)](https://github.com/fmjstudios/bashlib/actions/workflows/ci.yaml)
[![GitHub last commit](https://img.shields.io/github/last-commit/fmjstudios/bashlib?label=Activity)](https://github.com/fmjstudios/bashlib/commits/main/)

A library of open-source [MIT][license]-licensed [Bash][bash] scripts written and maintained by `FMJ Studios` for use
with [Bash][bash] version 5 and above. Refer to the GNU Projects's in-depth [Bash Documentation][bash_docs] for more
information on how these scripts work. Scripts meant for direct execution by the user, an init system or other means of
Expand Down
16 changes: 16 additions & 0 deletions docs/TODO.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,27 @@

## ➕ Additions

- Add sources of archived (private) project `vpsman`

## ✏️ Planned Changes

- Finish BATS testing for all of `lib`
- Add BATS testing for all `scripts`
- Transition to a BATS `setup_suite` to use more demanding tools like Container runtimes to `scripts` unit testing
- Add implementation for the `install` executable

## 💡 Ideas

- Add public URL to use the `install` executable like `get.bashlib.fmj.studio` using GitHub Pages

## 🔗 Links

- [BATS Docs - Tutorial](https://bats-core.readthedocs.io/en/stable/tutorial.html)
- [Google's Shell Style Guide](https://google.github.io/styleguide/shellguide.html)
- [jkroepke's Helm Secrets Plugin](https://github.com/jkroepke/helm-secrets/blob/main/tests/lib/setup_suite.bash) for BATS reference

### Installer

- [Docker's Install script](https://github.com/docker/docker-install)
- [Starship's Install script](https://github.com/starship/starship/blob/master/install/install.sh)
- [PNPM's INstall script](https://github.com/pnpm/get.pnpm.io/blob/main/install.sh)

0 comments on commit d033e45

Please sign in to comment.