skeletor 0.6.2 → 0.6.3

data/README.md

@@ -12,6 +12,37 @@ Installation
 Usage
 -----
 
+Skeletor has 3 actions it can perform for you.  You can also call `skeletor -h|--help` to list the available functions.
+
+###Build###
+
+	skeletor build TEMPLATE [options]
+	
+This will build the project skeleton for you based on TEMPLATE.  It takes the following options
+
+* `-d --directory DIRECTORY` Specifies the directory to build the skeleton in. If it doesn't exist Skeletor will create it for you. Defaults to the current directory.
+* `-p --project PROJECT` Specifies the name of the project to use in output.  I also intend to add in the functionality to add include parsing so you can dynamically insert the project name.  Defaults to the directory name.
+
+###Clean###
+
+	skeletor clean [options]
+	
+Cleans the entire project directory.  A helper method to let you start again. Useful when creating you templates. Takes the following options
+
+* `-d --directory` Specifies the directory to clean.  Defaults to the current directory.
+
+###Validate###
+
+	skeletor validate TEMPLATE
+	
+Validates that TEMPLATE is a valid YAML file and that it matches the expected schema (see below).
+
+###Help###
+
+	skeletor -h|--help TASK
+	
+Shows help information for TASK.
+
 Contributing to Skeletor
 ------------------------
  

data/lib/skeletor/cli.rb

@@ -24,8 +24,15 @@ module Skeletor
                   :aliases => "-d",
                   :desc => "Sets the target directory. Defaults to current directory"
     def clean
-      path = options[:directory] || Dir.pwd   
-      Builder.clean path
+      print 'Are you sure you want to clean this project directory? (Y|n): '
+      confirm = gets.chomp
+      if confirm != 'Y' && confirm != 'n'
+        puts 'Please enter Y or n'
+      elsif confirm == 'Y'
+        path = options[:directory] || Dir.pwd
+        Builder.clean path
+      end
+      
     end
     
     desc "validate TEMPLATE" ,"Checks TEMPLATE is a valid YAML file and matches the required schema."    

data/lib/skeletor/version.rb

@@ -1,3 +1,3 @@
 module Skeletor
-  VERSION="0.6.2"
+  VERSION="0.6.3"
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 6
-  - 2
-  version: 0.6.2
+  - 3
+  version: 0.6.3
 platform: ruby
 authors: 
 - Will McKenzie
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-09-25 00:00:00 +01:00
+date: 2011-09-26 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency