aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 7 insertions, 7 deletions
diff --git a/README.md b/README.md
index 06b27e7..44cf1a1 100644
--- a/README.md
+++ b/README.md
@@ -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: