Skip to content

Commit b1386f6

Browse files
Merge pull request #281 from Zearin/patch-2
Update README.md
2 parents 1e4526c + bc28e78 commit b1386f6

File tree

1 file changed

+30
-17
lines changed

1 file changed

+30
-17
lines changed

README.md

Lines changed: 30 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,11 @@
1212

1313
</div>
1414

15-
A shell compiler that converts shell scripts into secure, portable and static binaries. Unlike other tools (ie. [shc](https://github.com/neurobin/shc)), Bunster does not just wrap your script within a binary. It literally compiles them to standalone shell-independent programs.
15+
A shell compiler that converts shell scripts into secure, portable, and static binaries. Unlike other tools (i.e. [shc](https://github.com/neurobin/shc)), Bunster does not just wrap your script within a binary. It literally compiles them to standalone shell-independent programs.
1616

17-
Under the hood, **Bunster** transpiles shell scripts into [Go](https://go.dev) code. Then uses the [Go Toolchain](https://go.dev/dl) to compile the code to an executable.
17+
Under the hood, **Bunster** transpiles shell scripts into [Go](https://go.dev) code. Then it uses the [Go Toolchain](https://go.dev/dl) to compile the code to an executable.
1818

19-
**Bunster** aims to be compatible with `bash` as a starting move. Expecting that most `bash` scripts will just work with bunster. Additional shells will be supported as soon as we release v1.
19+
**Bunster** aims to be compatible with `bash` as a starting move. Expect that most `bash` scripts will just work with bunster. Additional shells will be supported as soon as we release v1.
2020

2121
> [!WARNING]
2222
> This project is in its early stages of development. [Only a subset of features are supported so far](https://bunster.netlify.app/features/simple-commands).
@@ -27,17 +27,17 @@ In addition to being compatible with bash. bunster offers a lot of additional fe
2727

2828
- **Static binaries**: scripts compiled with bunster are not just wrappers around your script, nor do they rely on any external shells on your system.
2929

30-
- **Modular**: unlike traditional shells scripts that are written in a single file. bunster offers a module system that allows you to distribute code across as many files as needed. [learn more](https://bunster.netlify.app/workspace/modules)
30+
- **Modular**: unlike traditional shells scripts that are written in a single file, bunster offers a module system that allows you to distribute code across as many files as needed. [learn more](https://bunster.netlify.app/workspace/modules)
3131

32-
- **Package Manager**: bunster has a buitlin package manager that makes it easy to publish and consume modules as libraries. [learn more](https://bunster.netlify.app/workspace/modules)
32+
- **Package Manager**: bunster has a builtin package manager that makes it easy to publish and consume modules as libraries. [learn more](https://bunster.netlify.app/workspace/modules)
3333

34-
- **Native `.env` files support**: `.env` files are nativily supported in bunster. Allowing you to load variables from `.env` files at runtime. [learn more](https://bunster.netlify.app/features/environment-files)
34+
- **Native `.env` files support**: `.env` files are natively supported in bunster, allowing you to load variables from `.env` files at runtime. [learn more](https://bunster.netlify.app/features/environment-files)
3535

36-
- **Static assets embedding**: bunster allows you to embed files and directories within your compiled program at compile time. And use them as if they were normal files in the system at runtime. [learn more](https://bunster.netlify.app/features/embedding)
36+
- **Static assets embedding**: bunster allows you to embed files and directories within your compiled program at compile time. Simply use them as if they were normal files in the system at runtime. [learn more](https://bunster.netlify.app/features/embedding)
3737

38-
- **Builtin flags parsing**: You no longer have to bother your self parsing flags manually. Just declare what flags you expect, and let bunster do the rest. [learn more](https://bunster.netlify.app/features/functions#flags)
38+
- **Builtin flags parsing**: You no longer have to bother yourself parsing flags manually. Just declare the flags you expect, and let bunster do the rest. [learn more](https://bunster.netlify.app/features/functions#flags)
3939

40-
- **Static analysis**: bunster statically analizes your scripts and reports potential bugs at compile time. (_wip_)
40+
- **Static analysis**: bunster statically analyzes your scripts and reports potential bugs at compile time. (_wip_)
4141

4242
## Get Started
4343

@@ -47,13 +47,18 @@ In addition to being compatible with bash. bunster offers a lot of additional fe
4747

4848
## Installation
4949

50-
We have bash script that installs `bunster` and adds it to your `$PATH`.
50+
We have a bash script that installs `bunster` and adds it to your `$PATH`.
5151

5252
```shell
5353
curl -f https://bunster.netlify.app/install.sh | bash
5454
```
5555

56-
The script will install bunster at `~/.local/bin/bunster` on linux. And `~/bin/bunster` on mac. If you want to install the binary system wide and make it accessible by all users.
56+
The script will install bunster at:
57+
58+
- `~/.local/bin/bunster` on Linux, and
59+
- `~/bin/bunster` on macOS.
60+
61+
If you want to install the binary system-wide, and make it accessible by all users:
5762

5863
```shell
5964
curl -f https://bunster.netlify.app/install.sh | GLOBAL=1 bash
@@ -65,25 +70,33 @@ curl -f https://bunster.netlify.app/install.sh | GLOBAL=1 bash
6570
brew install bunster
6671
```
6772

68-
Checkout the [documentation](https://bunster.netlify.app/installation) for different ways of installation.
73+
Checkout the [documentation](https://bunster.netlify.app/installation) for other ways to install bunster.
6974

7075
## Versioning
7176

72-
Bunster follows [SemVer](https://semver.org/) system for release versioning. On each minor release `v0.x.0`, you should expect adding new features, code optimization, and build improvements. On each patch release `v0.N.x`, you should expect bug fixes and/or other minor enhancements.
77+
Bunster follows [SemVer](https://semver.org/) system for release versioning. On each minor release `v0.x.0`, you can expect adding new features, code optimization, and build improvements. On each patch release `v0.N.x`, you can expect bug fixes and/or other minor enhancements.
7378

74-
Once we reach the stable release `v1.0.0`, you must expect your bash scripts to be fully compatible with Bunster (there might be some caveats). All features mentioned above to be implemented unless the community agreed on skipping some of them.
79+
Once we reach the stable release `v1.0.0`, you can expect your bash scripts to be fully compatible with bunster (there might be some caveats). All features mentioned above to be implemented unless the community agreed on skipping some of them.
7580

7681
Adding support for additional shells is not planned until our first stable release `v1`. All regarding contributions will remain open until then.
7782

78-
## Developers Guidline
83+
## Developer Guidelines
84+
85+
If you are interested in this project and want to know more about its underlying implementation, or if you want to contribute back but you don't know where to start, [we have a brief article](https://bunster.netlify.app/developers) that explains everything you need to get your hands dirty. Things like:
86+
87+
- the project structure, packages, and their concerns
88+
- how each component works and interacts with other components
89+
- how to add new features
90+
- how to improve existing features
91+
- testing
7992

80-
If you are interested in this project and want to know more about it's underlying implementation. Or if you want to contribute back but you don't know where to start. [We have brief article](https://bunster.netlify.app/developers) that explains everything you need to get your hands dirty. Things like the project structure, packages and their concerns, how each component work and interact with other components, how to add new features, how to improve existing features, testing and anything else in this regard.
93+
And anything else in this regard.
8194

8295
## Contributing
8396

8497
Thank you for considering contributing to the Bunster project! The contribution guide can be found in the [documentation](https://bunster.netlify.app/contributing).
8598

86-
This project is developed and maintained by the public community, which includes you. Anything in this repository is subject to criticism. Including features, the implementation, the code style, the way we manage code reviews, the documentation and anything else in this regard.
99+
This project is developed and maintained by the public community (which includes _you_!). Anything in this repository is subject to criticism. This includes features, the implementation, the code style, the way we manage code reviews, the documentation, and anything else in this regard.
87100

88101
Hence, if you think that we're doing something wrong, or have a suggestion that can make this project better, please consider opening an issue.
89102

0 commit comments

Comments
 (0)