materielize 0.0.9 → 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
data/README.md CHANGED
@@ -1,8 +1,8 @@
1
1
  # Materielize
2
2
 
3
- This is to assist in the always-messy proposition of configuration files and the like that need to be part of your project, but you don't want production credentials and such being posted in your repo. Also, as settings are added to project for new features (i.e., configuration settings in YAML files), team members will want to get the updated default settings for their development environment.
3
+ This is to assist in the always-messy proposition of configuration files and the like that need to be part of your Rails app, but you don't want production credentials and such being posted in your repo. Also, as settings are added to project for new features (i.e., configuration settings in YAML files), team members will want to get the updated default settings for their development environment.
4
4
 
5
- Materielize is born out of the way that I prefer to deal with this. I invariably have a 'materiel' directory that contains various things that are needed in the project, but not necessarily part of the code base. Also, I have a directory tree the mirrors the project itself with all of the default configuration files. When setting up the project fresh, materielize gives you Thor tasks to create the basic structure (install) and then copy config files over to your project from the default (init_config_files).
5
+ Materielize is born out of the way that I prefer to deal with this. I invariably have a 'materiel' directory that contains various things that are needed in the project, but not necessarily part of the code base. Also, I have a directory tree that mirrors the project itself with all of the default configuration files. When setting up the project fresh, materielize gives you rake tasks to create the basic structure (install) and then copy config files over to your project from the default (init_config_files).
6
6
 
7
7
  ## Installation
8
8
 
@@ -20,7 +20,15 @@ Or install it yourself as:
20
20
 
21
21
  ## Usage
22
22
 
23
- TODO: Write usage instructions here
23
+ $ rake materiel:install
24
+
25
+ Creates the materiel directory and the default_config_files subdirectory. The default config_files_directory root is a mirror-image of your project directory. File in this directory will be copied to the root directory of your project, sub directories are sub directories of your project and so on.
26
+
27
+ $ rake materiel:init_config_files
28
+ This copies files to their mirrored locations. If files are already present you will be prompted if you want to overwrite them.
29
+
30
+ $ rake materiel:uninstall
31
+ This will remove the materiel directory, recursively.
24
32
 
25
33
  ## Contributing
26
34
 
@@ -1,3 +1,3 @@
1
1
  module Materielize
2
- VERSION = "0.0.9"
2
+ VERSION = "1.0.0"
3
3
  end
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: materielize
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.0.9
4
+ version: 1.0.0
5
5
  prerelease:
6
6
  platform: ruby
7
7
  authors:
@@ -91,7 +91,6 @@ files:
91
91
  - lib/materielize.rb
92
92
  - lib/materielize/railtie.rb
93
93
  - lib/materielize/version.rb
94
- - lib/root.txt
95
94
  - lib/tasks/materiel.rake
96
95
  - lib/tasks/materiel.thor
97
96
  - materielize.gemspec
data/lib/root.txt DELETED
@@ -1 +0,0 @@
1
- This directory will reflect the root directory of your project. Things put here will be copied to your project's root directory. Subdirectories and their content will be copied as subdirectories of your project root, etc.