searching works now (pager missing)

[phorkie.git] / README.rst

diff --git a/README.rst b/README.rst
index 18c0f88297f9adb2ef2119171cd8752e71e3422b..f5c93f2a98ce1aa164c855775a349c505482f958 100644 (file)
--- a/README.rst
+++ b/README.rst
@@ -12,14 +12,25 @@ Homepage: http://sourceforge.net/p/phorkie/
 Features
 ========
 - every paste is a git repository
+
+  - repositories can be cloned
+  - clone url can be displayed
 - paste editing
 
   - add new files
   - delete existing files
+  - replace file with upload
 - multiple files in one paste
 - syntax highlighting with GeSHi
 - rST rendering
+- image upload + display
+- external tool support
+
+  - xmllint
+  - php syntax check
+- history in the sidebar
 
+  - old files can be downloaded easily
 
 ============
 Dependencies
@@ -33,6 +44,19 @@ Install VersionControl_Git
 
   $ pear install versioncontrol_git-alpha
 
+Install Services_Libravatar
+==========================
+::
+
+  $ pear install services_libravatar-alpha
+
+
+Install Date_HumanDiff
+======================
+::
+
+  $ pear install https://github.com/downloads/cweiske/Date_HumanDiff/Date_HumanDiff-0.1.0.tgz
+
 
 Install GeSHi
 =============
@@ -82,15 +106,18 @@ Technical details
 
 TODO
 ====
+- filters (xmllint --format, rapper)
 - search
 - OpenID-Login to get username+email as authorship information
-- sidebar: history
-- image upload
 - document how to keep disk usage low (block size)
 - comments
 - when 2 people edit, merge changes
 - diff changes
 - configurable highlights
+- tags
+- autotags for file types
+- Atom feed for new pastes
+- Atom feed for paste changes
 
 
 URLs
@@ -106,10 +133,10 @@ URLs
   Display raw file contents
 ``/[0-9]/delete``
   Delete the paste
-``/search(/.+)?``
-  Search for term
+``/search(/[0-9]+)?q=..``
+  Search for term, with optional page
 ``/list(/[0-9])?``
-  List all pastes
+  List all pastes, with optional page
 
 
 Internal directory layout
@@ -117,10 +144,13 @@ Internal directory layout
 ::
 
   repos/
-    1/ - git repository for paste #1
-      .git/
+    work/
+      1/ - work directory for paste #1
+      2/ - work directory for paste #2
+    git/
+      1.git/ - git repository for paste #1
         description - Description for the repository
-    2/ - git repository for paste #2
+      2.git/ - git repository for paste #2
 
 
 Search