summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorEkaitz Zarraga <ekaitz@elenq.tech>2024-03-25 17:41:50 +0100
committerEkaitz Zarraga <ekaitz@elenq.tech>2024-03-25 17:41:50 +0100
commit75b29d9cda09a1198e1a01b0f98b6620c743c556 (patch)
tree77319980e91cb5fb28324879874e02e617fbf173 /README.md
parentac890434673792044f8c02aa0e2d8751080b3d92 (diff)
doc: document the projectHEADmaster
Diffstat (limited to 'README.md')
-rw-r--r--README.md13
1 files changed, 11 insertions, 2 deletions
diff --git a/README.md b/README.md
index bdae113..7089470 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,13 @@
# Guile Neocities
-Guile library for and command line tool for [Neocities
-API](https://neocities.org/api).
+Guile API and command line tool for [Neocities API](https://neocities.org/api).
+
+If you wish to read some documentation, the `doc` folder should cover your
+needs. If you want to read it in a better format, you can use `texinfo` to
+convert it to Info, PDF or HTML.
+
+If you want to play around with the command line tool, install it using the
+documentation and just run `neocities --help` to learn how to use it.
+
+If you are interested on the Guile API, you should take a look to the docs, and
+use `neocities/cli.scm` as a source of simple and useful examples.