Skip to content
This repository was archived by the owner on Jun 26, 2024. It is now read-only.

Commit 3eefad0

Browse files
authored
πŸ“– Project pitch (#64)
πŸ“– Add reference to bindl.dev/notes
1 parent 1f60df7 commit 3eefad0

File tree

1 file changed

+14
-3
lines changed

1 file changed

+14
-3
lines changed

β€ŽREADME.md

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,24 @@ Bindl is a downloader for programs used in a project, often not necessary at run
77

88
Bindl is an distro-agnostic, offering ease of consistency in managing binaries across operating systems and distributions.
99

10+
## Why?
11+
12+
At the core of it, Bindl is standardizing and securing the work of `curl && chmod`. Through Bindl, projects can rest assured that dependencies and programs are always verified through checksum (and signature if provided).
13+
14+
The ergonomics of adopting Bindl is about making sure that for a given commit in a project, it will have consistent dependency version and installation mechanism regardless of which machine is running.
15+
16+
To learn more about why Bindl exists and how it works, [take a look at the guides](https://bindl.dev/notes).
17+
1018
## Usage / Installation
1119

1220
Available under [examples/](examples/) directory. In short:
1321

14-
```
15-
export OUTDIR=/usr/local/bin # or whichever directory you'd like bindl to exist
16-
curl --location https://bindl.dev/bootstrap.sh | bash # though seriously, please read first on what bootstrap.sh does.
22+
```bash
23+
# Whichever directory you'd like bindl to exist
24+
export OUTDIR=/usr/local/bin
25+
26+
# While it's convenient, please inspect bootstrap.sh before running :)
27+
curl --location https://bindl.dev/bootstrap.sh | bash
1728
```
1829

1930
You may try to install with `go get`, though versioning information may be incomplete as they are stamped in build.

0 commit comments

Comments
Β (0)