Deleted unused ./test directory
[feedcatcher.git] / README.rdoc
index e07ab78e9c230285b252ddb70cbff1044bbb3f0b..0cf3c2a99d804011f0694e57f4dcf0f03a58b215 100644 (file)
@@ -1,5 +1,4 @@
 == Welcome to Feedcatcher
-
 Feedcatcher is a lightweight RSS server that accepts write requests from anonymous clients. It was developed for the {Sense programming environment}[http://sense.open.ac.uk].
 
 Feedcatcher was the first version of the RSS server. It has since been reimplemented, more robustly, by the {Open University}[http://www.open.ac.uk] for use in the {My Digital Life module}[http://www3.open.ac.uk/study/undergraduate/course/tu100.htm]. However, this version should still work with Sense. It's not been tested with the very latest versions, but nothing in that part of Sense has changed since it used this implementation of Feedcatcher.
@@ -7,13 +6,11 @@ Feedcatcher was the first version of the RSS server. It has since been reimpleme
 Feel free to clone and modify this application. Let me know what you do with it!
 
 == Installation
+Feedcatcher is written in Rails 4.0.2 and runs on Ruby 2.1.0. 
 
-Feedcatcher is written in Rails 2.3.2 (vendored in) and runs on Ruby 1.8.7. I've not tried it with later versions of Ruby or Rails. Updating Ruby should be OK, but changing to Rails 3.x will probably break things.
-
-You'll need to update the create the +database.yml+ and +deploy.rb+ files for your installation. You can use the +database.sample.yml+ and +deploy.sample.rb+ files as templates. In particular, +deploy.sample.rb+ still refers to when feedcatcher was stored in a Subversion repository.
+You'll need to update the create the +database.yml+ and +deploy.rb+ files for your installation. You can use the +database.sample.yml+ and +deploy.sample.rb+ files as templates. 
 
 == Instructions
-
 Visiting http://feedcatcher.example.com in a browser will give you an HTML view of the feeds available.  
 
 Visiting http://feedcatcher.example.com/feed-a or http://feedcatcher.example.com/feed-a.html will show you the contents of that feed. The HTML pages also have a little form to allow you to update the contents of feeds.
@@ -62,6 +59,6 @@ This deletes an item:
   http://feedcatcher.example.com
 
 ===Notes
-
 When you ask for HTML pages, the responses are likely to be redirects to the next page.  You shouldn't get HTTP error codes.
-Responses to POSTs made with "Accept: application/rss+xml" headers will often be empty, with the success or failure of the action indicated in the HTTP response code.
+
+Responses to POSTs made with "Accept: application/rss+xml" headers will often be empty, with the success or failure of the action indicated in the HTTP response code.
\ No newline at end of file