aboutsummaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
authorChristian Weiske <cweiske@cweiske.de>2012-03-25 21:08:29 +0200
committerChristian Weiske <cweiske@cweiske.de>2012-03-25 21:08:29 +0200
commit6d0777840e50ce98f3d96629b4e92bbdccd3001c (patch)
tree161a753bf54b4fec0c4357b16dc68ff838e20383 /README.rst
parent568bf6f9a487a3dc33ce52e45cd31cfbea2cb79e (diff)
downloadphorkie-6d0777840e50ce98f3d96629b4e92bbdccd3001c.tar.gz
phorkie-6d0777840e50ce98f3d96629b4e92bbdccd3001c.zip
first code that allows you to create pastes and view them
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst37
1 files changed, 37 insertions, 0 deletions
diff --git a/README.rst b/README.rst
index e69de29..ea8a940 100644
--- a/README.rst
+++ b/README.rst
@@ -0,0 +1,37 @@
+************************************
+Phorkie - PHP and Git based pastebin
+************************************
+
+URLs
+====
+
+``/``
+ Index page. Shows form for new paste
+``/[0-9]+``
+ Display page for paste
+``/[0-9]/edit``
+ Edit the paste
+``/[0-9]+/raw/(.+)``
+ Display raw file contents
+``/[0-9]/delete``
+ Delete the paste
+``/search(/.+)?``
+ Search for term
+``/list(/[0-9])?``
+ List all pastes
+
+
+Internal directory layout
+=========================
+::
+
+ repos/
+ 1/ - git repository for paste #1
+ .git/
+ description - Description for the repository
+ 2/ - git repository for paste #2
+
+
+Search
+======
+Use ``ack-grep``