diff --git a/frontend/README.md b/frontend/README.md index 23e81c0..c766be1 100644 --- a/frontend/README.md +++ b/frontend/README.md @@ -14,11 +14,11 @@ In your HTML, add the following: ```html
- - + data-element="ucs-comments" + data-ucs_url="[SERVICE_URL]" + data-site="[WEBSITE]" + data-path="[PAGE_PATH]" +> + + ``` diff --git a/readme.md b/readme.md new file mode 100644 index 0000000..e3ba861 --- /dev/null +++ b/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 + +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 +
+ + +``` diff --git a/screenshot.png b/screenshot.png new file mode 100644 index 0000000..51a7978 Binary files /dev/null and b/screenshot.png differ