summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDavid Thompson <dthompson2@worcester.edu>2014-08-09 11:46:21 -0400
committerDavid Thompson <dthompson2@worcester.edu>2014-08-09 11:46:21 -0400
commit958f41c3e106d4f3c43616716a751a84e10c96d5 (patch)
treee1d028b88640dd92433e60a79cff242d82e9082e
parent7f5005a7034952c958df1d84767097778593a1a1 (diff)
Update README.
README.md ("Features", "Wishlist", "Dependencies"): New sections.
-rw-r--r--README.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/README.md b/README.md
index 35ef584..5ad3a8f 100644
--- a/README.md
+++ b/README.md
@@ -4,12 +4,32 @@ Guix-web
A web interface to the GNU Guix package manager written in GNU Guile
and JavaScript.
+Features
+--------
+
+* Convenient package searching interface
+* View detailed descriptions of Guix packages
+* JSON API
+
+Wishlist
+--------
+
+* Package installation/removal/rollback
+* Profile viewer
+
Use
---
Simply run `./pre-inst-env guix-web` and visit `localhost:8080` in
your web browser.
+Dependencies
+------------
+
+* [GNU Guile](https://gnu.org/s/guile) >= 2.0.5
+* [GNU Guix](https://gnu.org/s/guix) >= 0.6
+* [guile-json](https://github.com/aconchillo/guile-json) >= 0.3.1
+
Copyright
---------