Skip to content

Commit 7766be0

Browse files
committed
Initialize README and gemspec
1 parent 1fab09b commit 7766be0

File tree

2 files changed

+15
-50
lines changed

2 files changed

+15
-50
lines changed

README.md

Lines changed: 2 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,13 @@
1-
# Sqldef
1+
# sqldef-ruby
22

3-
Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/sqldef`. To experiment with that code, run `bin/console` for an interactive prompt.
4-
5-
TODO: Delete this and the text above, and describe your gem
3+
Ruby interface to call [sqldef](https://github.com/k0kubun/sqldef).
64

75
## Installation
86

9-
Add this line to your application's Gemfile:
10-
117
```ruby
128
gem 'sqldef'
139
```
1410

15-
And then execute:
16-
17-
$ bundle install
18-
19-
Or install it yourself as:
20-
21-
$ gem install sqldef
22-
23-
## Usage
24-
25-
TODO: Write usage instructions here
26-
27-
## Development
28-
29-
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.
30-
31-
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).
32-
33-
## Contributing
34-
35-
Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/sqldef.
36-
3711
## License
3812

3913
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

sqldef.gemspec

Lines changed: 13 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,28 @@
11
# frozen_string_literal: true
22

3-
require_relative "lib/sqldef/version"
3+
require_relative 'lib/sqldef/version'
44

55
Gem::Specification.new do |spec|
6-
spec.name = "sqldef"
6+
spec.name = 'sqldef'
77
spec.version = Sqldef::VERSION
8-
spec.authors = ["Takashi Kokubun"]
9-
spec.email = ["takashikkbn@gmail.com"]
8+
spec.authors = ['Takashi Kokubun']
9+
spec.email = ['takashikkbn@gmail.com']
1010

11-
spec.summary = "TODO: Write a short summary, because RubyGems requires one."
12-
spec.description = "TODO: Write a longer description or delete this line."
13-
spec.homepage = "TODO: Put your gem's website or public repo URL here."
14-
spec.license = "MIT"
15-
spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
11+
spec.summary = 'Idempotent MySQL/PostgreSQL schema management by SQL'
12+
spec.description = 'Idempotent MySQL/PostgreSQL schema management by SQL'
13+
spec.homepage = 'https://github.com/sqldef/sqldef-ruby'
14+
spec.license = 'MIT'
15+
spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
1616

17-
spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
18-
19-
spec.metadata["homepage_uri"] = spec.homepage
20-
spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here."
21-
spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
17+
spec.metadata['homepage_uri'] = spec.homepage
18+
spec.metadata['source_code_uri'] = spec.homepage
2219

2320
# Specify which files should be added to the gem when it is released.
2421
# The `git ls-files -z` loads the files in the RubyGem that have been added into git.
2522
spec.files = Dir.chdir(File.expand_path(__dir__)) do
2623
`git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
2724
end
28-
spec.bindir = "exe"
25+
spec.bindir = 'exe'
2926
spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
30-
spec.require_paths = ["lib"]
31-
32-
# Uncomment to register a new dependency of your gem
33-
# spec.add_dependency "example-gem", "~> 1.0"
34-
35-
# For more information and examples about making a new gem, checkout our
36-
# guide at: https://bundler.io/guides/creating_gem.html
27+
spec.require_paths = ['lib']
3728
end

0 commit comments

Comments
 (0)