aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorStruan Donald <struan@exo.org.uk>2012-08-22 10:57:10 +0100
committerStruan Donald <struan@exo.org.uk>2012-08-22 10:57:10 +0100
commit2e0a4e8ec45579e4e5c9cf8aa123d5ab215b9703 (patch)
treec13e3c59b686e01460dc7960547f7e9c53c288bd /README.md
parentb99c5ff97b29a27eeba52ed24385ac30388e875c (diff)
parent88a7d38dffa3dabdf0f85573b254cea9c8ab232b (diff)
Merge remote-tracking branch 'origin/master' into fmb-read-only
Conflicts: .gitignore bin/make_css conf/general.yml-example perllib/FixMyStreet/App/Controller/Council.pm perllib/FixMyStreet/App/Controller/Report/New.pm perllib/FixMyStreet/Cobrand/Default.pm templates/web/default/around/around_index.html templates/web/default/index.html templates/web/emptyhomes/index.html templates/web/fixmystreet/around/around_index.html templates/web/fixmystreet/index.html web/fixmystreet_app_cgi.cgi web/fixmystreet_app_fastcgi.cgi
Diffstat (limited to 'README.md')
-rw-r--r--README.md28
1 files changed, 28 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 000000000..32d3c4740
--- /dev/null
+++ b/README.md
@@ -0,0 +1,28 @@
+# Welcome to FixMyStreet Platform
+
+FixMyStreet Platform is an open source project to help people run websites for
+reporting common street problems such as potholes and broken street lights to
+the appropriate authority.
+
+Users locate problems using a combination of address and sticking a pin
+in a map without worrying about the correct authority to report it to.
+FixMyStreet then works out the correct authority using the problem location and
+type and sends a report, by email or using a web service such as Open311.
+Reported problems are visible to everyone so they can see if something has
+already been reported and leave updates. Users can also subscribe to email or
+RSS alerts of problems in their area.
+
+It was created in 2007 by [mySociety](http://www.mysociety.org/) for reporting
+problems to UK councils and has been copied around the world.
+
+## Installation
+
+We're working hard to make FixMyStreet Platform easy to install and re-use in
+other countries - please see our site at <http://code.fixmystreet.com/> for
+help and documentation in installing FixMyStreet Platform.
+
+## Examples
+
+* <http://www.fixmystreet.com/>
+* <http://www.fiksgatami.no/>
+