README.md in config_curator-0.5.0 vs README.md in config_curator-1.0.0
- old
+ new
@@ -2,17 +2,23 @@
[![Gem Version](https://img.shields.io/gem/v/config_curator.svg)](https://rubygems.org/gems/config_curator)
[![MIT License](https://img.shields.io/github/license/razor-x/config_curator.svg)](./LICENSE.txt)
[![Dependency Status](https://img.shields.io/gemnasium/razor-x/config_curator.svg)](https://gemnasium.com/razor-x/config_curator)
[![Build Status](https://img.shields.io/travis/razor-x/config_curator.svg)](https://travis-ci.org/razor-x/config_curator)
-[![Coverage Status](https://img.shields.io/codecov/c/github/razor-x/config_curator.svg)](https://codecov.io/github/razor-x/config_curator)
-[![Code Climate](https://img.shields.io/codeclimate/github/razor-x/config_curator.svg)](https://codeclimate.com/github/razor-x/config_curator)
by Evan Boyd Sosenko.
_Simple and intelligent configuration file management._
+📢 Version 1 is the first and last stable release.
+
+🎉 Config Curator has been **rewritten from scratch in Node.js:**
+https://github.com/rxrc/curator.
+Users are encouraged to use the Node.js version
+which is much faster, has zero dependencies,
+and provides an improved feature set with a similar manifest format.
+
## Description
Config Curator is a flexible configuration and dotfile manager.
Simply define what to manage in `manifest.yml`,
then run `curate` to install and update your **configuration units**.
@@ -208,29 +214,16 @@
v, [--verbose], [--no-verbose]
q, [--quiet], [--no-quiet]
[--debug], [--no-debug]
```
-#### Uninstalling units
-
-Currently all units have an uninstall method.
-Smart uninstall via `curate uninstall` is planned for an
-[upcoming release](https://github.com/razor-x/config_curator/issues/7).
-
### Scripting
Config Curator is fully scriptable for easy inclusion into other Ruby programs.
The API is well documented for this purpose
(see [Documentation](#documentation) above).
-### Plugins
-
-Plugin support is
-[planned for an upcoming release](https://github.com/razor-x/config_curator/issues/8).
-If you like Config Curator and want to write a plugin,
-please let me know!
-
## Installation
You can install the gem either with Bundler or directly.
Bundler is preferred, however the direct method may be convenient
when initially bootstrapping a system with an initial configuration.
@@ -281,20 +274,20 @@
Run `rake -T` to see all Rake tasks.
```
rake all # Run all tasks
-rake build # Build config_curator-0.3.0.gem into the pkg directory
+rake build # Build config_curator-1.0.0.gem into the pkg directory
rake bump:current[tag] # Show current gem version
rake bump:major[tag] # Bump major part of gem version
rake bump:minor[tag] # Bump minor part of gem version
rake bump:patch[tag] # Bump patch part of gem version
rake bump:pre[tag] # Bump pre part of gem version
rake bump:set # Sets the version number using the VERSION environment variable
-rake install # Build and install config_curator-0.3.0.gem into system gems
-rake install:local # Build and install config_curator-0.3.0.gem into system gems without network access
-rake release # Create tag v0.3.0 and build and push config_curator-0.3.0.gem to Rubygems
+rake install # Build and install config_curator-1.0.0.gem into system gems
+rake install:local # Build and install config_curator-1.0.0.gem into system gems without network access
+rake release # Create tag v1.0.0 and build and push config_curator-1.0.0.gem to Rubygems
rake rubocop # Run RuboCop
rake rubocop:auto_correct # Auto-correct RuboCop offenses
rake spec # Run RSpec code examples
rake yard # Generate YARD Documentation
```
@@ -326,9 +319,15 @@
Config Curator is licensed under the MIT license.
## Warranty
-This software is provided "as is" and without any express or
-implied warranties, including, without limitation, the implied
-warranties of merchantibility and fitness for a particular
-purpose.
+This software is provided by the copyright holders and contributors "as is" and
+any express or implied warranties, including, but not limited to, the implied
+warranties of merchantability and fitness for a particular purpose are
+disclaimed. In no event shall the copyright holder or contributors be liable for
+any direct, indirect, incidental, special, exemplary, or consequential damages
+(including, but not limited to, procurement of substitute goods or services;
+loss of use, data, or profits; or business interruption) however caused and on
+any theory of liability, whether in contract, strict liability, or tort
+(including negligence or otherwise) arising in any way out of the use of this
+software, even if advised of the possibility of such damage.