Sha256: 2e117fd5a9f1304575d3b0eb382bc7a3c130abc8e6d01bcb51d1108001e3dcf1

Contents?: true

Size: 1.13 KB

Versions: 14

Compression:

Stored size: 1.13 KB

Contents

# Vault::Tools

Tools is the English word for ツール.  Tooling for the Heroku Vault
team to enable faster bootstrapping for Ruby projects.

[![Build Status](https://travis-ci.org/heroku/vault-tools.png?branch=master)](https://travis-ci.org/heroku/vault-tools)

## Setting up a development environment

Install the dependencies:

    bundle install --binstubs vendor/bin
    rbenv rehash

Run the tests:

    vendor/bin/t

Generate the API documentation:

    vendor/bin/d


## Installation

Add this line to your application's Gemfile:

    gem 'vault-tools'


## Usage

### Logging

```ruby
  Log.time(name, t)
  #  => "measure=true at=web-40"

  Log.count('foo')
  #  => "measure=true at=foo"
```

### Sinatra base class

Includes request logging and health endpoints

```ruby
  class Web < Vault::Web
    helpers Vault::SinatraHelpers::HtmlSerializer
  end
```

## 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

## Releasing

    > bundle exec rake release

Version data entries

14 entries across 14 versions & 1 rubygems

Version Path
vault-tools-0.5.5 README.md
vault-tools-0.5.4 README.md
vault-tools-0.5.3 README.md
vault-tools-0.5.2 README.md
vault-tools-0.5.1 README.md
vault-tools-0.5.0 README.md
vault-tools-0.4.15 README.md
vault-tools-0.4.14 README.md
vault-tools-0.4.13 README.md
vault-tools-0.4.12 README.md
vault-tools-0.4.11 README.md
vault-tools-0.4.10 README.md
vault-tools-0.4.9 README.md
vault-tools-0.4.8 README.md