From 511cd51730827206fce9d854587679183ac4632f Mon Sep 17 00:00:00 2001 From: Nemo Date: Sun, 26 Apr 2020 08:37:23 +0530 Subject: [PATCH] [docs] Adds ruby in docs --- CODE_OF_CONDUCT.md | 74 +++++++++++++++++++++++++++++++++++++++ HACKING.md | 7 ++++ README.md | 28 +++++++++++++++ pincode-validator.gemspec | 2 -- 4 files changed, 109 insertions(+), 2 deletions(-) create mode 100644 CODE_OF_CONDUCT.md diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..a8c1274 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,74 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +In the interest of fostering an open and welcoming environment, we as +contributors and maintainers pledge to making participation in our project and +our community a harassment-free experience for everyone, regardless of age, body +size, disability, ethnicity, gender identity and expression, level of experience, +nationality, personal appearance, race, religion, or sexual identity and +orientation. + +## Our Standards + +Examples of behavior that contributes to creating a positive environment +include: + +* Using welcoming and inclusive language +* Being respectful of differing viewpoints and experiences +* Gracefully accepting constructive criticism +* Focusing on what is best for the community +* Showing empathy towards other community members + +Examples of unacceptable behavior by participants include: + +* The use of sexualized language or imagery and unwelcome sexual attention or +advances +* Trolling, insulting/derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or electronic + address, without explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Our Responsibilities + +Project maintainers are responsible for clarifying the standards of acceptable +behavior and are expected to take appropriate and fair corrective action in +response to any instances of unacceptable behavior. + +Project maintainers have the right and responsibility to remove, edit, or +reject comments, commits, code, wiki edits, issues, and other contributions +that are not aligned to this Code of Conduct, or to ban temporarily or +permanently any contributor for other behaviors that they deem inappropriate, +threatening, offensive, or harmful. + +## Scope + +This Code of Conduct applies both within project spaces and in public spaces +when an individual is representing the project or its community. Examples of +representing a project or community include using an official project e-mail +address, posting via an official social media account, or acting as an appointed +representative at an online or offline event. Representation of a project may be +further defined and clarified by project maintainers. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported by contacting the project team at me@captnemo.in. All +complaints will be reviewed and investigated and will result in a response that +is deemed necessary and appropriate to the circumstances. The project team is +obligated to maintain confidentiality with regard to the reporter of an incident. +Further details of specific enforcement policies may be posted separately. + +Project maintainers who do not follow or enforce the Code of Conduct in good +faith may face temporary or permanent repercussions as determined by other +members of the project's leadership. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, +available at [http://contributor-covenant.org/version/1/4][version] + +[homepage]: http://contributor-covenant.org +[version]: http://contributor-covenant.org/version/1/4/ diff --git a/HACKING.md b/HACKING.md index bbae66f..0c13c39 100644 --- a/HACKING.md +++ b/HACKING.md @@ -16,3 +16,10 @@ 1. `git tag 1.2.3` 2. `git push --tags` + + +## Ruby Development + +After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment. + +To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org). diff --git a/README.md b/README.md index 1a16b12..069ce3d 100644 --- a/README.md +++ b/README.md @@ -32,6 +32,22 @@ const P = require('pincode-validator'); P.validate('110011'); // returns true ```` +## Ruby + +Add this line to your application's Gemfile: + +```ruby +gem 'pincode_validator' +``` + +And then execute: + + $ bundle + +Or install it yourself as: + + $ gem install pincode_validator + ### Browser To use it in the browser, download the `pincode-regex.js` file and include it in your browser. `Pincode` is available as a Global variable. @@ -43,10 +59,22 @@ Pincode.validate("560029"); // returns true ``` +Since there is no hotline/CDN for this yet, please watch to repo to get notified of new releases. + +## Contributing + +Bug reports and pull requests are welcome on GitHub at https://github.com/captn3m0/outliner. + +## Code of Conduct + +Everyone interacting in the this project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/captn3m0/outliner/blob/master/CODE_OF_CONDUCT.md). + + ## Contributing - See [`HACKING.md`](HACKING.md) for some development details. - Pull requests are welcome for adding libraries in other languages (in the same repo). +- This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct. ## License diff --git a/pincode-validator.gemspec b/pincode-validator.gemspec index c8957ec..edc6a21 100644 --- a/pincode-validator.gemspec +++ b/pincode-validator.gemspec @@ -13,8 +13,6 @@ Gem::Specification.new do |spec| spec.metadata["homepage_uri"] = spec.homepage spec.metadata["source_code_uri"] = "https://github.com/captn3m0/india-pincode-regex" - # Specify which files should be added to the gem when it is released. - # The `git ls-files -z` loads the files in the RubyGem that have been added into git. spec.files = [ 'Gemfile', 'LICENSE',