works with published version of wfpl, started on documentation

[contractor-progress.git] / README

diff --git a/README b/README
new file mode 100644 (file)
index 0000000..aafe13a
--- /dev/null
+++ b/README
@@ -0,0 +1,49 @@
+This project is a website for managing tasks between a freelance programmer and
+their clients.
+
+Current features:
+
+       1) Password protection
+
+       2) Add client accounts
+
+       3) Enter and edit task descriptions
+
+       4) Clients can save as draft or save and request price from contractor
+
+       6) Contractor can set a price or mark a task description as needing
+       clarification.
+
+       5) Clients can approve price or edit further (or let it sit)
+
+       6) Contractor can mark a task as in-progress at which point it is no longer
+       editable.
+
+       7) Contractor can mark a task as finished (needing testing). Then client can
+       test and mark it as confirmed finished.
+
+
+       Client's display is sorted into tasks needing their attention and tasks that
+       are waiting for contractor.
+
+       Contractor's display lists tasks needing his attention from all clients.
+       Contractor has additional page allowing him to switch his session to be logged
+       in as any of the clients.
+
+
+Planned features in a probably order of appearance:
+
+       1) Clients can re-order the queue (the list of tasks which are approved
+       and priced, but work hasn't started yet)
+
+       2) Contractor gets an e-mail whenever a client causes a task to move into
+       his list of things to attend to.
+
+       3) Contractor can add money to the client's balance, and system will
+       automatically mark finished tasks as paid, and reduce the balance.
+
+       4) Contractor can auto-generate an invoice from tasks and contact info in
+       the database.
+
+       5) Site detects when client's balance is too low for work to continue and
+       displays that prominently to them.