edward/bunbun
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

update readme

Browse source
This commit is contained in:
Edward Shen 2020-01-01 00:29:37 -05:00
parent ec04821462
commit 9cc2d5952e
Signed by: edward
GPG key ID: F350507060ED6C90
1 changed files with 25 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

38
README.md
View file

@ -3,7 +3,7 @@
_Self-hostable, easy-to-configure, fast search/jump multiplexer service._ _Self-hostable, easy-to-configure, fast search/jump multiplexer service._
bunbun is a pure-[Rust][rust-lang] implementation of [bunny1][bunny1], providing bunbun is a pure-[Rust][rust-lang] implementation of [bunny1][bunny1], providing
a customizable search engine and quick-jump tool in one. a customizable search engine and quick-jump tool in one small binary.
After adding it to your web-browser and setting it as your default search After adding it to your web-browser and setting it as your default search
engine, you'll gain the ability to quick-jump to a specific page or search from engine, you'll gain the ability to quick-jump to a specific page or search from
@ -18,14 +18,35 @@ foo bar // If foo is a defined command, do something with bar
// query for the default route // query for the default route
``` ```
## Reasons to use bunbun
- Convenient: bunbun watches for config changes and refreshes its routes
automatically, allowing for rapid development.
- Extensible: supports simple route substitution or execution of arbitrary
programs for complex route resolution.
- Portable: bunbun runs off a single binary and config file.
- Small: binary is 1.3MB (after running `strip` and `upx --lzma` on the release
binary).
- Memory-safe: Built with [Rust][rust-lang].
## Installation ## Installation
If you have `cargo`, you can simply run `cargo install bunbun`. If you have `cargo`, you can simply run `cargo install bunbun`.
Once installed, simply run it. A default config file will be created if one does Once installed, simply run it. A default config file will be created if one does
not exist. You should model your own custom routes after the provided ones. not exist.
### Building for prod If you're looking to run this as a daemon (as most would do), you should put the
binary in `/usr/bin` and copy `aux/systemd/bunbun.service` into your preferred
systemd system folder. Then you may run `systemctl enable bunbun --now` to start
a daemon instance of bunbun.
If running Arch Linux, you may use the provided `PKGBUILD` to install bunbun.
Run `makepkg` followed by `sudo pacman -U bunbun.<version>.tar.gz`. This
installs the systemd service for you. Run `systemctl enable bunbun --now` to
start bunbun as a daemon.
### Building for production
If you're looking to build a release binary, here are the steps I use: If you're looking to build a release binary, here are the steps I use:
@ -43,7 +64,7 @@ If configuring for development, no further configuration is required. If running
this for production, you should edit the `public_address` field. this for production, you should edit the `public_address` field.
the config file is watched, so updates are immediate unless invalid, or if the config file is watched, so updates are immediate unless invalid, or if
you're using certain programs such as nvim, which performs updating a file via you're using certain programs such as `nvim`, which performs updating a file via
swapping rather than directly updating the file. swapping rather than directly updating the file.
### Adding bunbun as a search engine ### Adding bunbun as a search engine
@ -51,15 +72,6 @@ swapping rather than directly updating the file.
bunbun supports the [OpenSearch Description Format][osdf]. Visit the root page bunbun supports the [OpenSearch Description Format][osdf]. Visit the root page
of your desired instance of bunbun to learn more. of your desired instance of bunbun to learn more.
## Reasons to use bunbun
- Portable: bunbun runs off a single binary and config file.
- Small: binary is 1.3MB (after running `strip` and `upx --lzma` on the release
binary).
- Convenient: bunbun watches for config changes and refreshes its routes
automatically, allowing for rapid development.
- Memory-safe: Built with [Rust][rust-lang].
[rust-lang]: https://www.rust-lang.org/ [rust-lang]: https://www.rust-lang.org/
[bunny1]: http://www.bunny1.org/ [bunny1]: http://www.bunny1.org/
[osdf]: https://developer.mozilla.org/en-US/docs/Web/OpenSearch [osdf]: https://developer.mozilla.org/en-US/docs/Web/OpenSearch