diff options
| author | Yotam Nachum <me@yotam.net> | 2019-12-07 11:50:58 +0200 |
|---|---|---|
| committer | Yotam Nachum <me@yotam.net> | 2019-12-07 11:50:58 +0200 |
| commit | 7316ce78a2e06677acbb786620c603780076f377 (patch) | |
| tree | 5662061002c65ab83faa61507084b5719e96008f /README.md | |
| parent | Validate request scheme (diff) | |
| download | shavit-7316ce78a2e06677acbb786620c603780076f377.tar.gz shavit-7316ce78a2e06677acbb786620c603780076f377.zip | |
Give the project a proper name
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 14 |
1 files changed, 7 insertions, 7 deletions
@@ -1,9 +1,9 @@ -# Go Gemini Server +# Shavit -This is a yet to be named configurable Gemini server for UNIX operating systems. -The server is in a very early state and can only serve static files but in the -near future it will support dynamically generated files like a search endpoints -and an Atom feed. +Shavit is a configurable Gemini server for UNIX operating systems. The server +is in a very early state and can only serve static files but in the near future +it will support dynamically generated files like a search endpoints and an Atom +feed. ## Building @@ -11,12 +11,12 @@ The server is written in Go so to build it you only need to run one command: go build -This will produce a binary named `go-gemini-server` that you can run. +This will produce a binary named `shavit` that you can run. ## Running After you have compiled the server you need to configure it before it will run. -The server expect a configuration file in `/etc/gemini/config.toml` that contain +The server expect a configuration file in `/etc/shavit/config.toml` that contain a path to the documents directory and the certificate files. A simple configuration file might look like this: |