Permalink
Browse files

Initial update of README

  • Loading branch information...
0 parents commit 67cff3e798e31097745d96d06995c53a6f11589f @bdmac committed Mar 1, 2013
Showing with 111 additions and 0 deletions.
  1. +17 −0 .gitignore
  2. +4 −0 Gemfile
  3. +22 −0 LICENSE.txt
  4. +36 −0 README.md
  5. +1 −0 Rakefile
  6. +5 −0 lib/strong_password.rb
  7. +3 −0 lib/strong_password/version.rb
  8. +23 −0 strong_password.gemspec
17 .gitignore
@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
4 Gemfile
@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in strong_password.gemspec
+gemspec
22 LICENSE.txt
@@ -0,0 +1,22 @@
+Copyright (c) 2013 Brian McManus
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
36 README.md
@@ -0,0 +1,36 @@
+# StrongPassword
+
+StrongPassword provides entropy-based password strength checking for your apps.
+
+The idea stemmed from the
+"[Checking Password Strength](http://stackoverflow.com/questions/549/the-definitive-guide-to-forms-based-website-authentication)"
+section on StackOverflow.
+
+It is an adaptation of a [PHP algorithm](http://cubicspot.blogspot.com/2011/11/how-to-calculate-password-strength.html)
+developed by Thomas Hruska.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+ gem 'strong_password'
+
+And then execute:
+
+ $ bundle
+
+Or install it yourself as:
+
+ $ gem install strong_password
+
+## Usage
+
+Usage instructions
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
1 Rakefile
@@ -0,0 +1 @@
+require "bundler/gem_tasks"
5 lib/strong_password.rb
@@ -0,0 +1,5 @@
+require "strong_password/version"
+
+module StrongPassword
+ # Your code goes here...
+end
3 lib/strong_password/version.rb
@@ -0,0 +1,3 @@
+module StrongPassword
+ VERSION = "0.0.1"
+end
23 strong_password.gemspec
@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'strong_password/version'
+
+Gem::Specification.new do |spec|
+ spec.name = "strong_password"
+ spec.version = StrongPassword::VERSION
+ spec.authors = ["Brian McManus"]
+ spec.email = ["bdmac97@gmail.com"]
+ spec.description = %q{TODO: Write a gem description}
+ spec.summary = %q{TODO: Write a gem summary}
+ spec.homepage = ""
+ spec.license = "MIT"
+
+ spec.files = `git ls-files`.split($/)
+ spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+ spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
+ spec.require_paths = ["lib"]
+
+ spec.add_development_dependency "bundler", "~> 1.3"
+ spec.add_development_dependency "rake"
+end

0 comments on commit 67cff3e

Please sign in to comment.