readme

frontend/README.md

@@ -14,11 +14,11 @@ In your HTML, add the following:
 
 ```html
 <div id="ucs-comments"
-        data-element="ucs-comments"
+     data-element="ucs-comments"
-        data-ucs_url="[BACKEND_URL]"
+     data-ucs_url="[SERVICE_URL]"
-        data-site="[WEBSITE]"
+     data-site="[WEBSITE]"
-        data-path="[PAGE_PATH]"
+     data-path="[PAGE_PATH]"
-     ></div>
+></div>
-<script type="module" src="[FRONTEND_URL]/index.js"></script>
+<script type="module" src="[SERVICE_URL]/ucs.js"></script>
-<link rel="stylesheet" type="text/css" href="[FRONTEND_URL]/index.css">
+<link rel="stylesheet" type="text/css" href="[SERVICE_URL]/ucs.css">
 ```

readme.md

@@ -0,0 +1,42 @@
+# Universe Comment System
+
+A web service adding comments to websites.
+
+The backend service serves as a simple read/write database for comments per site/page,
+and the frontend is an embeddable component you can place in your page that will interact with
+the backend service.
+
+## Screenshot
+
+<img src="screenshot.png" alt="screnshot">
+
+## Build
+
+Requires node.js.
+
+Use `./bundle.sh` to generate a `.tar.gz` containing the service.
+
+## Run
+
+Extract the archive file produced by `bundle.sh` into a directory,
+for example:
+
+```sh
+mkdir ucs/ && tar xzvf ucs-*.tar.gz -C ucs/
+```
+
+Create a configuration file for your website in `./ucs/config/production.json`.
+See [backend/config/default.json](./backend/config/default.json) for an example configuration.
+
+Then add the following HTML to your website page, changing the parameters marked in `[]`:
+
+```html
+<div id="ucs-comments"
+     data-element="ucs-comments"
+     data-ucs_url="[SERVICE_URL]"
+     data-site="[WEBSITE]"
+     data-path="[PAGE_PATH]"
+></div>
+<script type="module" src="[SERVICE_URL]/ucs.js"></script>
+<link rel="stylesheet" type="text/css" href="[SERVICE_URL]/ucs.css">
+```