updated readme and gemspec

README.md

@@ -1,16 +1,80 @@
-= Cost Control Plugin
+OpenProject Costs Plugin
+===========================
 
-This plugin adds the ability to book costs and reports on them.
+This Plugin adds features for planning and tracking costs of projects. Budgets can be created containing the planned unit costs and labor costs. The actual costs can be assigned to the different work packages and planned and actual costs can be compared.
 
-= Requirements
+A more detailed description can be found on [OpenProject.org](https://www.openproject.org/projects/openproject/wiki/Time_and_Cost).
 
-== Gems
 
-=== Composite Primary Keys
+Requirements
+------------
 
-Not used anymore, tends to break things during group by operations containing an include)
+The OpenProject Backlogs plug-in requires the [OpenProject Core](https://github.com/opf/openproject/) in version greater or equal to *3.0.0pre37*.
 
-URL: http://compositekeys.rubyforge.org/
+Tests for this plugin require `pdf-inspector`, so just add the following line to OpenProject's `Gemfile.plugin`:
 
-Install with
+`gem "pdf-inspector", "~>1.0.0", :group => :test`
-sudo gem install composite_primary_keys
+
+
+Installation
+------------
+
+OpenProject Backlogs depends on OpenProject Plugins. Thus, if you haven't done it already, add the following line to the `Gemfile.plugins` to your OpenProject installation:
+
+`gem "openproject-plugins", git: "https://github.com/opf/openproject-plugins.git", :branch => "dev"`
+
+For OpenProject Backlogs itself you need to add the following line to the `Gemfile.plugins` of OpenProject:
+
+`gem "openproject-backlogs", git: "https://github.com/finnlabs/openproject-backlogs.git", :branch => "dev"`
+
+Afterwards, run:
+
+`bundle install`
+
+This plugin contains migrations. To migrate the database, run:
+
+`rake db:migrate`
+
+
+Deinstallation
+--------------
+
+Remove the line
+
+`gem "openproject-backlogs", git: "https://github.com/finnlabs/openproject-backlogs.git"`
+
+from the file `Gemfile.plugins` and run:
+
+`bundle install`
+
+Please not that this leaves plugin data in the database. Currently, we do not support full uninstall of the plugin.
+
+
+Bug Reporting
+-------------
+
+If you find any bugs, you can create a bug ticket at
+
+https://www.openproject.org/projects/plugin-backlogs
+
+
+Development
+-----------
+
+To contribute, you can create pull request on the official repository at
+`https://github.com/finnlabs/openproject-backlogs`
+
+
+Credits
+-------
+
+Special thanks go to
+
+* Deutsche Telekom AG (opensource@telekom.de) for project sponsorship
+
+Licence
+-------
+
+Copyright (C) 2009 - 2014 the OpenProject Foundation (OPF)
+
+This plugin is licensed under the GNU GPL v3. See doc/COPYRIGHT.md and doc/GPL.txt for details.

openproject-costs.gemspec

@@ -10,14 +10,14 @@ Gem::Specification.new do |s|
   s.authors = "Finn GmbH"
   s.email = "info@finn.de"
   s.homepage = "http://www.finn.de"
-  s.summary     = "A OpenProject plugin to manage costs"
+  s.summary     = "An OpenProject plugin to manage project costs"
-  s.description = "This plugin allows to track labor and units cost associated with work packages."
+  s.description = "This Plugin adds features for planning and tracking costs of projects."
 
-  s.files = Dir["{app,config,db,lib}/**/*", "CHANGELOG.md", "README.md"]
+  s.files = Dir["{app,config,db,lib,doc}/**/*", "README.md"]
   s.test_files = Dir["spec/**/*"]
 
   s.add_dependency "rails", "~> 3.2.9"
-  s.add_dependency "openproject-plugins", "~> 1.0.4"
+  s.add_dependency "openproject-plugins", "~> 1.0.6"
 
   s.add_development_dependency "factory_girl_rails", "~> 4.0"
 end