diff options
| author | Fuwn <[email protected]> | 2021-08-13 23:11:56 -0700 |
|---|---|---|
| committer | GitHub <[email protected]> | 2021-08-13 23:11:56 -0700 |
| commit | 19555f9ef1265c5312b8d1535983c0ce45b71949 (patch) | |
| tree | 4847dd359cb42d50ab82795844943c38145edc4d | |
| parent | chore(assets): delete leftover logo (diff) | |
| download | capybara-19555f9ef1265c5312b8d1535983c0ce45b71949.tar.xz capybara-19555f9ef1265c5312b8d1535983c0ce45b71949.zip | |
chore(readme): make it prettier
| -rw-r--r-- | README.rst | 32 |
1 files changed, 15 insertions, 17 deletions
@@ -13,11 +13,9 @@ Capybara Synopsis -------- -This is an `HTTP <https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol>`__ -to `Gemini <https://gemini.circumlunar.space/>`__ proxy designed to provide -service for a single domain, i.e. to make your Gemini site available over HTTP. -It can proxy to any domain in order to facilitate linking to the rest of -Geminispace, but it defaults to a specific domain. +Capybara is an `HTTP <https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol>`__ +to `Gemini <https://gemini.circumlunar.space/>`__ proxy designed to ... proxy ... +Gemini capsules over to HTTP. Usage ----- @@ -27,27 +25,27 @@ Usage $ go build $ ./capybara [-b 127.0.0.1:8080] [-s style.css] [-e style.css] gemini://fuwn.space --b -~~ +:code:`-b` (:code:`BIND`) +~~~~~~~~~~~~~~~~~~~~~~~~~ -The -b argument is optional and allows you to bind to an arbitrary address; by -default Capybara will bind to :code:`:8080`. You should set up some external +The :code:`-b` argument is optional and allows you to bind to an arbitrary address; +by default Capybara will bind to :code:`:8080`. You should set up some external reverse proxy like nginx to forward traffic to this port and add TLS. --s -~~ +:code:`-s` (:code:`CSS`) +~~~~~~~~~~~~~~~~~~~~~~~~ -The -s argument is optional and allows you to specify a custom CSS filename. +The :code:`-s` argument is optional and allows you to specify a custom CSS filename. The given file will be loaded from the local disk and placed in a :code:`<style>` block. By default Capybara will serve its built-in style. --e -~~ +:code:`-e` (:code:`CSS_EXTERNAL`) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -The -e argument is optional and allows you to specify a custom CSS URL. If -provided, the style.css given will be treated as a link to be put in the href +The :code:`-e` argument is optional and allows you to specify a custom CSS URL. +If provided, the style.css given will be treated as a link to be put in the href of a :code:`<link rel="stylesheet"...>` instead of being placed inline with the -body in a :code:`<style>` block like with the -s flag. The given stylesheet can +body in a :code:`<style>` block like with the :code:`-s` flag. The given stylesheet can be a relative link, for instance :code:`-e /main.css` will serve :code:`main.css` from the root of the proxied Gemini capsule. |