Skip to content

Commit

Permalink
[project] docs/license/changelog/version
Browse files Browse the repository at this point in the history
  • Loading branch information
RustamCadoLabs committed Mar 14, 2024
1 parent 2bc52e3 commit e94a39f
Show file tree
Hide file tree
Showing 5 changed files with 57 additions and 17 deletions.
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Changelog
All notable changes to this project will be documented in this file.

[0.4.0] - 2024-03-15
- Moved to `smart-rb` (`CadoLabs`);
2 changes: 1 addition & 1 deletion Gemfile.lock
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
PATH
remote: .
specs:
smart_validator (0.3.0)
smart_validator (0.4.0)
qonfig (~> 0.28)
smart_initializer (~> 0.11)
smart_schema (~> 0.11)
Expand Down
21 changes: 21 additions & 0 deletions LICENSE.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
The MIT License (MIT)

Copyright (c) 2024 AnotherRegularDude (https://github.com/AnotherRegularDude)

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.
44 changes: 29 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,33 +1,47 @@
# SmartValidator
# SmartCore::Validator

Watch specs.
---

## Installation
<img src="https://github.com/Cado-Labs/cado-labs-resources/blob/main/cado_labs_supporting_rounded.svg" alt="Supported by Cado Labs" />

---

Add this line to your application's Gemfile:
## Installation

```ruby
gem 'smart_validator'
```

And then execute:

$ bundle install
```shell
bundle install
# --- or ---
gem install smart_validator
```

Or install it yourself as:
```ruby
require 'smart_core/validator'
```

$ gem install smart_validator
---

## Usage

TODO: Write usage instructions here
- soon;

## Development
---

After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
## Contributing

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 the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
- Fork it ( https://github.com/smart-rb/smart_validator )
- Create your feature branch (`git checkout -b feature/my-new-feature`)
- Commit your changes (`git commit -am '[feature_context] Add some feature'`)
- Push to the branch (`git push origin feature/my-new-feature`)
- Create new Pull Request

## Contributing
## License

Released under MIT License.

## Authors

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/smart_validator.
[AnotherRegularDude] (https://github.com/AnotherRegularDude)
2 changes: 1 addition & 1 deletion lib/smart_core/validator/version.rb
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@

module SmartCore
module Validator
VERSION = '0.3.0'
VERSION = '0.4.0'
end
end

0 comments on commit e94a39f

Please sign in to comment.