From 11963657cd83a123ce49d8876a1673238a997678 Mon Sep 17 00:00:00 2001
From: rautenberg <rautenberg@in-silico.ch>
Date: Tue, 25 Feb 2014 10:09:38 +0100
Subject: make README markdown and link RubyDoc.info

---
 README    | 32 --------------------------------
 README.md | 41 +++++++++++++++++++++++++++++++++++++++++
 2 files changed, 41 insertions(+), 32 deletions(-)
 delete mode 100644 README
 create mode 100644 README.md

diff --git a/README b/README
deleted file mode 100644
index 4b5783b..0000000
--- a/README
+++ /dev/null
@@ -1,32 +0,0 @@
-opentox-server: Common part for OpenTox webservices
-
-Installation:
-
-  gem install opentox-service
-
-Development:
-
-  git clone git@github.com:<my-opentox-service>.git 
-  cd <my-opentox-service>
-  bundle install
-  ./bin/toxbank-investigation-install # if not already installed, do not start webserver
-  export RACK_ENV=development
-  # if you are working on opentox-server|client gems as well edit Gemfile e.g.
-  # gem 'opentox-server', :path => "~/opentox-server"
-  # gem "opentox-client", :path => "~/opentox-client"
-  # start webserver in development mode (runs at port 8080, should reload changes from source files)
-  unicorn
-  # open new terminal
-  git flow init 
-  git flow feature start <your feature>
-  # code, test, code, ...
-  git flow feature finish <your feature>
-  # test
-  # create release branch
-  # increase version (in toxbank-investigation.gemspec)
-  # install into system gems
-  rake install
-  # test
-  # create master
-  # release
-  rake release
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..511e9cf
--- /dev/null
+++ b/README.md
@@ -0,0 +1,41 @@
+opentox-server: Common part for OpenTox webservices
+===================================================
+
+Installation:
+-------------
+
+  gem install opentox-service
+
+Development:
+------------
+
+  git clone git@github.com:<my-opentox-service>.git 
+  cd <my-opentox-service>
+  bundle install
+  ./bin/toxbank-investigation-install # if not already installed, do not start webserver
+  export RACK_ENV=development
+  # if you are working on opentox-server|client gems as well edit Gemfile e.g.
+  # gem 'opentox-server', :path => "~/opentox-server"
+  # gem "opentox-client", :path => "~/opentox-client"
+  # start webserver in development mode (runs at port 8080, should reload changes from source files)
+  unicorn
+  # open new terminal
+  git flow init 
+  git flow feature start <your feature>
+  # code, test, code, ...
+  git flow feature finish <your feature>
+  # test
+  # create release branch
+  # increase version (in toxbank-investigation.gemspec)
+  # install into system gems
+  rake install
+  # test
+  # create master
+  # release
+  rake release
+
+
+Documentation
+-------------
+* [API documentation](http://opentox.org/dev/api)
+* [RubyDoc.info Code documentation](http://rubydoc.info/github/opentox/opentox-server/development/frames)
-- 
cgit v1.2.3