rename Phorkie to phorkie (lowercase)
[phorkie.git] / README.rst
1 ************************************
2 phorkie - PHP and Git based pastebin
3 ************************************
4
5 URLs
6 ====
7
8 ``/``
9   Index page. Shows form for new paste
10 ``/[0-9]+``
11   Display page for paste
12 ``/[0-9]/edit``
13   Edit the paste
14 ``/[0-9]+/raw/(.+)``
15   Display raw file contents
16 ``/[0-9]/delete``
17   Delete the paste
18 ``/search(/.+)?``
19   Search for term
20 ``/list(/[0-9])?``
21   List all pastes
22
23
24 Internal directory layout
25 =========================
26 ::
27
28   repos/
29     1/ - git repository for paste #1
30       .git/
31         description - Description for the repository
32     2/ - git repository for paste #2
33
34
35 Search
36 ======
37 Use ``ack-grep``
38
39
40 Install geshi
41 =============
42 ::
43
44   $ pear channel-discover mediawiki.googlecode.com/svn
45   $ pear install mediawiki/geshi
46
47
48 TODO
49 ====
50 - edit
51 - search
52 - OpenID-Login to get username+email as authorship information
53 - sidebar: history
54 - image upload
55 - rst rendering
56 - document how to keep disk usage low (block size)
57 - comments
58 - when 2 people edit, merge changes
59 - diff changes
60 - configurable highlights