arno/isso
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

decrease headings

Browse Source
This commit is contained in:
posativ 2012-10-17 22:55:25 +02:00
parent 98328eebb0
commit 54f1176249
1 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
Readme.md
View File

@ -11,7 +11,7 @@ a comment system that is under your control. This is, were Isso comes into play.
Current status: `nosetests specs/`. Ran 11 tests in 0.570s. Current status: `nosetests specs/`. Ran 11 tests in 0.570s.
# Features/Roadmap ## Features/Roadmap
- transparent and lightweight backend (SQLite or plain text files) - transparent and lightweight backend (SQLite or plain text files)
- simple JSON API (hence comments are JavaScript-only) - simple JSON API (hence comments are JavaScript-only)
@ -21,17 +21,17 @@ Current status: `nosetests specs/`. Ran 11 tests in 0.570s.
- easy integration, similar to Disqus (not implemented yet) - easy integration, similar to Disqus (not implemented yet)
- spam filtering using [http:bl](https://www.projecthoneypot.org/) (not implemented yet) - spam filtering using [http:bl](https://www.projecthoneypot.org/) (not implemented yet)
# Installation ## Installation
TODO TODO
# API ## API
## fetch comments for /foo-bar/ ### fetch comments for /foo-bar/
$ curl -H "Accept: application/json" http://example.org/comment/foo-bar/ $ curl -H "Accept: application/json" http://example.org/comment/foo-bar/
## comment at /foo-bar/ ### comment at /foo-bar/
$ curl -H "Accept: application/json" -X POST -d \ $ curl -H "Accept: application/json" -X POST -d \
'{ '{
@ -39,15 +39,15 @@ TODO
# optional # optional
"name": "Hans", "email": "foo@bla.org", "website": "http://blog/log/" "name": "Hans", "email": "foo@bla.org", "website": "http://blog/log/"
}' \ http://example.org/comment/foo-bar/new }' http://example.org/comment/foo-bar/new
## modify 12. comment at /foo-bar/ ### modify 12. comment at /foo-bar/
$ curl -H "Accept: application/json" -X PUT -d ... http://example.org/comment/foo-bar/12 $ curl -H "Accept: application/json" -X PUT -d ... http://example.org/comment/foo-bar/12
You can only modify your own comment in a given time range (defaults to 15 minutes). You can only modify your own comment in a given time range (defaults to 15 minutes).
## delete 2nd comment at /foo-bar/ ### delete 2nd comment at /foo-bar/
$ curl -H ... -X DELETE http://example.org/comment/foo-bar/2 $ curl -H ... -X DELETE http://example.org/comment/foo-bar/2
@ -55,7 +55,7 @@ You can only delete your own comment in a given time range (defaults to 15 minut
your comment has been referenced by another comment, your comment will be cleared but not your comment has been referenced by another comment, your comment will be cleared but not
deleted to maintain depending comments. deleted to maintain depending comments.
# Alternatives ## Alternatives
- [Juvia](https://github.com/phusion/juvia) – Ruby on Rails - [Juvia](https://github.com/phusion/juvia) – Ruby on Rails
- [Tildehash.com](http://www.tildehash.com/?article=why-im-reinventing-disqus) – PHP - [Tildehash.com](http://www.tildehash.com/?article=why-im-reinventing-disqus) – PHP