parent:
daa607db77c458c7a8501d4832981d3707004391
nmyk <nick@nmyk.io>
2026-02-23T22:50:01-05:00
improve README.md
diff --git a/README.md b/README.md index e1269cc5b2cdb6f0e121b6657b492529f530d1f0..8c9bc9bb1718eb9128957449d1e45e827d174a8d 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,34 @@ # bidet -Bidet is a simple web frontend for git. +``` + ___ +[___] _ +| ~| =)_)= +| | (_( +| | )_) +\___| + | `========, +__`. BIDET .'___ + `. .' + _| |_... + (________);;;; + :::::::' +``` +Bidet is a pure HTML server-side rendered web interface for git repositories. It is hooked up to the plumbing, but it's all output, no input. +* Minimal, fast, easy to deploy +* Supports clone, fetch, and pull operations +* Straightforward to style with custom CSS; templates use no custom classes + ## Usage -``` -NAME - bidet - -FLAGS - -p, --port INT port for the server (default: 8080) - -h, --hostname STRING hostname of server - -g, --greeting STRING greeting for index page - -d, --directory STRING directory containing your bare git repositories (default: .) - -s, --css STRING path or URL to a CSS stylesheet -``` +### Options + * `-p`, `--port`: port for the server (default: 8080) + * `-h`, `--hostname`: hostname of server + * `-g`, `--greeting`: greeting for index page + * `-d`, `--directory`: directory containing your bare git repositories (default: `.`) + * `-s`, `--css`: path or URL to a CSS stylesheet Bidet can also be configured with environment variables: ``` @@ -24,4 +37,26 @@ BIDET_HOSTNAME BIDET_GREETING BIDET_DIRECTORY BIDET_CSS -``` \ No newline at end of file +``` + +### Hostname + +The `--hostname` flag or `BIDET_HOSTNAME` variable should match the host people will use in `git clone` commands. + +### Greeting + +The `--greeting` flag or `BIDET_GREETING` variable is an optional subheader for your repository index page. Describe the purpose of your site, write a funny message, or leave it blank. + +### Custom CSS + +Unlike centralized, corporate-owned Git web hosts, Bidet's appearance is fully customizable. Its templates only use classless elements so there's no naming scheme you need to learn before writing your own stylesheet. It's pretty much just `<p>`, `<a>`, `<hr>`, some lists (`<ul>`/`<li>`), heading elements (`<h1>` to `<h4>`), and `<pre>`. + +The `--css` flag or `BIDET_CSS` environment variable accepts a local CSS file path or a URL. The custom stylesheet is loaded once at startup, so external CSS files will not be hotlinked. + +## Contributing + +```shell +git clone https://git.nmyk.io/bidet.git +``` + +Send your patch in plain text `git diff` format to bidet@git.nmyk.io. \ No newline at end of file