update readme

Cargo.toml

@@ -6,6 +6,7 @@ edition = "2018"
 description = "Re-implementation of bunny1 in Rust"
 license = "AGPL-3.0"
 readme = "README.md"
+repository = "https://github.com/edward-shen/bunbun"
 
 [dependencies]
 actix-web = "1.0"

README.md

@@ -25,5 +25,23 @@ 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
 not exist. You should model your own custom routes after the provided ones.
 
+### Configuration
+
+If configuring for development, no further configuration is required. If running
+this for production, you should edit the `public_address` field.
+
+### Adding bunbun as a search engine
+
+bunbun supports the [OpenSearch Description Format][osdf].
+
+For Chrome, simply visiting the index page will auto add bunbun as a search
+engine. You simply need to set it as a default in your preferences.
+
+For Firefox, you need to explicitly add bunbun as a search engine. This can be
+done by clicking the three dots next to the star button on the url box, and
+clicking on "Add Search Engine". Then, you can set it as your default search
+engine.
+
 [rust-lang]: https://www.rust-lang.org/
 [bunny1]: http://www.bunny1.org/
+[osdf]: https://developer.mozilla.org/en-US/docs/Web/OpenSearch

bunbun.default.toml

@@ -1,6 +1,11 @@
+# The location which your server is listening on and binds to
 bind_address: "127.0.0.1:8080"
+
+# The root location where people can access your instance of bunbun
 public_address: "localhost:8080"
 
+# A default route, if no route is was matched. If none were matched, the entire
+# query is used as the query for the default route. This field is optional.
 default_route: "g"
 
 routes: