wrap at 80 chars

This commit is contained in:
posativ 2012-12-16 14:00:40 +01:00
parent ba33f28f31
commit 5968a977ab

53
README
View File

@ -1,10 +1,11 @@
Isso Ich schrei sonst Isso Ich schrei sonst
======================= =======================
You love static blog generators (especially [Acrylamid][1] \*cough\*) and the only You love static blog generators (especially [Acrylamid][1] \*cough\*) and the
option to interact with the community is [Disqus][2]. There's nothing wrong with only option to interact with the community is [Disqus][2]. There's nothing
it, but if you care about the privacy of your audience you should better use wrong with it, but if you care about the privacy of your audience you should
a comment system that is under your control. This is, were Isso comes into play. better use a comment system that is under your control. This is, were Isso
comes into play.
[1]: https://github.com/posativ/acrylamid [1]: https://github.com/posativ/acrylamid
[2]: http://disqus.com/ [2]: http://disqus.com/
@ -13,7 +14,7 @@ Current Status
-------------- --------------
- `nosetests specs/` ⇾ *Ran 17 tests in 0.491s* - `nosetests specs/` ⇾ *Ran 17 tests in 0.491s*
- `(cd /path/static/html/ && isso)` ⇾ fire up your browser and visit your site except for `/` - `(cd /path/static/html/ && isso)` ⇾ fire up your browser and visit `localhost:8080`
Features/Roadmap Features/Roadmap
---------------- ----------------
@ -25,16 +26,19 @@ Features/Roadmap
- [ ] Ping/Trackback support - [ ] Ping/Trackback support
- [w] simple admin interface - [w] simple admin interface
- [w] easy integration, similar to Disqus - [w] easy integration, similar to Disqus
- [ ] spam filtering using [http:bl](https://www.projecthoneypot.org/) - [ ] spam filtering using [http:bl][3]
[3]: https://www.projecthoneypot.org/
Development Development
----------- -----------
*Note:* This project is proudly made with the Not Invented Here syndrome, instead of `werkzeug` *Note:* This project is proudly made with the Not Invented Here syndrome,
or `bottle` it uses about 100 lines to manage WSGI and instead of JQuery it uses ender.js. instead of `werkzeug` or `bottle` it uses about 100 lines to manage WSGI
and instead of JQuery it uses ender.js.
You'll need [2.6 ≤ python ≤ 2.7](http://python.org), [ender.js](http://ender.no.de/) and You'll need [2.6 ≤ python ≤ 2.7][4], [ender.js][5] and [YUI Compressor][6].
[YUI Compressor](http://developer.yahoo.com/yui/compressor/). Then run: Then run:
$ git clone https://github.com/posativ/isso.git && cd isso/ $ git clone https://github.com/posativ/isso.git && cd isso/
$ make init $ make init
@ -43,6 +47,10 @@ You'll need [2.6 ≤ python ≤ 2.7](http://python.org), [ender.js](http://ender
Then go to <http://localhost:8080/static/post.html> and write a comment :-) Then go to <http://localhost:8080/static/post.html> and write a comment :-)
[4]: http://python.org
[5]: http://ender.no.de/
[6]: http://developer.yahoo.com/yui/compressor/
Installation Installation
------------ ------------
@ -57,8 +65,8 @@ weird with that download link. Next:
$ isso import /path/to/ur/dump.xml $ isso import /path/to/ur/dump.xml
That's it. Visit your admin page to see all threads. If it doesn't work for you, That's it. Visit your admin page to see all threads. If it doesn't work for
please file in a bug report \*including\* your dump. you, please file in a bug report \*including\* your dump.
API API
--- ---
@ -67,9 +75,9 @@ To fetch all comments for a path, run
$ curl http://example.org/comment/foo-bar/ $ curl http://example.org/comment/foo-bar/
To write a comment, you have to POST a JSON dictionary with the following key-value To write a comment, you have to POST a JSON dictionary with the following
pairs. Text is mandatory otherwise you'll get a 400 Bad Request. You'll also get key-value pairs. Text is mandatory otherwise you'll get a 400 Bad Request.
a 400 when your JSON is invalid. You'll also get a 400 when your JSON is invalid.
Let's say you want to comment on /foo-bar/ Let's say you want to comment on /foo-bar/
@ -79,17 +87,18 @@ Let's say you want to comment on /foo-bar/
"name": "Hans", "email": "foo@bla.org", "website": "http://blog/log/" "name": "Hans", "email": "foo@bla.org", "website": "http://blog/log/"
}' }'
This will set a cookie, that expires in a few minutes (15 minutes per default). This This will set a cookie, that expires in a few minutes (15 minutes per default).
cookie allows you do modify or delete your comment. Don't try to modify that cookie, This cookie allows you do modify or delete your comment. Don't try to modify
it is cryptographically signed. If your cookie is outdated or modified, you'll get that cookie, it is cryptographically signed. If your cookie is outdated or
a 403 Forbidden. modified, you'll get a 403 Forbidden.
For each comment you'll post, you get an unique cookie. Let's try to remove your comment: For each comment you'll post, you get an unique cookie. Let's try to remove
your comment:
$ curl -X DELETE http://example.org/comment/foo-bar/1 $ curl -X DELETE http://example.org/comment/foo-bar/1
If your comment has been referenced by another comment, your comment will be cleared but If your comment has been referenced by another comment, your comment will be
not deleted to retain depending comments. cleared but not deleted to retain depending comments.
Alternatives Alternatives
------------ ------------