Skip to content

Commit

Permalink
Adds some initial placeholder gem configuration
Browse files Browse the repository at this point in the history
  • Loading branch information
a-maas committed Nov 8, 2018
1 parent 330ca8d commit f7ddf5b
Show file tree
Hide file tree
Showing 5 changed files with 20 additions and 11 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,4 @@
/pkg/
/spec/reports/
/tmp/
Gemfile.lock
2 changes: 1 addition & 1 deletion LICENSE.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
The MIT License (MIT)

Copyright (c) 2018 Adam Maas
Copyright (c) 2018 Custom Ink

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# VertexClient

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/vertex_client`. To experiment with that code, run `bin/console` for an interactive prompt.
The Vertex Client Ruby Gem provides an interface to integrate with Vertex Cloud's REST API.

TODO: Delete this and the text above, and describe your gem
TODO: Write more introduction after Gem is more built out.

## Installation

Expand All @@ -26,7 +26,7 @@ TODO: Write usage instructions here

## Development

After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/test` to run the tests. 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).

Expand Down
8 changes: 8 additions & 0 deletions bin/test
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
#!/usr/bin/env bash
set -euo pipefail
IFS=$'\n\t'
set -vx

rake test

# Do any other automated setup that you need to do here
14 changes: 7 additions & 7 deletions vertex_client.gemspec
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,12 @@ require "vertex_client/version"
Gem::Specification.new do |spec|
spec.name = "vertex_client"
spec.version = VertexClient::VERSION
spec.authors = ["Adam Maas"]
spec.email = ["amaas@customink.com"]
spec.authors = ["Custom Ink"]
spec.email = ["technology@customink.com"]

spec.summary = %q{TODO: Write a short summary, because RubyGems requires one.}
spec.description = %q{TODO: Write a longer description or delete this line.}
spec.homepage = "TODO: Put your gem's website or public repo URL here."
spec.summary = %q{A Ruby Gem to integrate with the Vertex Cloud API}
spec.description = %q{The Vertex Client Ruby Gem provides an interface to integrate with Vertex Cloud's REST API.}
spec.homepage = "https://github.com/customink/vertex_client"
spec.license = "MIT"

# Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
Expand All @@ -20,8 +20,8 @@ Gem::Specification.new do |spec|
spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"

spec.metadata["homepage_uri"] = spec.homepage
spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here."
spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
spec.metadata["source_code_uri"] = "https://github.com/customink/vertex_client"
spec.metadata["changelog_uri"] = "https://github.com/customink/vertex_client/CHANGELOG.md"
else
raise "RubyGems 2.0 or newer is required to protect against " \
"public gem pushes."
Expand Down

0 comments on commit f7ddf5b

Please sign in to comment.