summary refs log tree commit diff stats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md60
1 files changed, 56 insertions, 4 deletions
diff --git a/README.md b/README.md
index 0472192..fd2e6a0 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,61 @@
 # clinte   [![Build Status](https://travis-ci.com/gbmor/clinte.svg?branch=master)](https://travis-ci.com/gbmor/clinte) [![codecov](https://codecov.io/gh/gbmor/clinte/branch/master/graph/badge.svg)](https://codecov.io/gh/gbmor/clinte)
 
-Command-line community notice board. Post simple notes for other users to see. Username is tagged automatically.
+Command-line community notice board. Post simple notes for other users to see. 
 
-Limits:
-* Title -> 30 chars
-* Body -> 500 chars
+## Features
+
+* Username is tagged based on the executing user
+* Shows the 30 most recent posts in descending order
+* Title <= 30 chars
+* Body <= 500 chars
 
 [![Screenshot](https://github.com/gbmor/clinte/blob/master/assets/clinte.png)](https://github.com/gbmor/clinte/blob/master/assets/clinte.png)
+
+## Installation
+
+Current build dependencies are as follows:
+
+* `rustc/cargo >= 1.36`
+* `libsqlite3-dev`
+
+The installation for the build deps will vary based on your OS (`Linux, BSD`)
+
+Clone the repository and jump into the directory:
+
+```
+$ git clone git://github.com/gbmor/clinte.git
+...
+$ cd clinte
+```
+
+Run the makefile and install:
+
+```
+$ make
+...
+...Done!
+
+$ sudo make install
+```
+
+## Usage
+
+Issuing the program name itself will list
+the currently available posts, like in the screenshot above.
+
+To make a new post:
+
+```
+$ clinte post
+```
+
+`clinte` will then ask for the title of the post, and the body. The username will be
+tagged automatically by your logged-in username, reflecting its intended use on
+multi-user UNIX-like systems.
+
+## Contributing
+
+This is very new, so feel free to hack on it in any way you
+please and submit a PR! I'll be working on it myself over the next several days
+to flesh it out.
+