Sha256: 5bdbee5a20e94be5707b044595da1a3bbe9ba2758f0e6090357055dc085c76ea

Contents?: true

Size: 1.71 KB

Versions: 1

Compression:

Stored size: 1.71 KB

Contents

[![Build Status](https://travis-ci.org/koffeinfrei/technologist.svg?branch=master)](https://travis-ci.org/koffeinfrei/technologist)

# Technologist

This library detects the technologies used in a repository.

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'technologist'
```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install technologist

## Usage

```ruby
require 'technologist'

technologist = Technologist::Repository.new('.')
technologist.primary_frameworks      # => ['Sinatra']
technologist.secondary_frameworks    # => ['Dashing']
technologist.frameworks              # => ['Sinatra', 'Dashing']
```

## Development

After checking out the repo, run `bin/setup` to install dependencies. Then, 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` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).

## Contributing

To add a framework definition add a new section to the
[frameworks.yml](lib/technologist/frameworks.yml) file and
add a new spec covering the new framework in [spec/frameworks_rules_spec.rb](spec/frameworks_rules_spec.rb)

1. Fork it ( https://github.com/koffeinfrei/technologist/fork )
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 a new Pull Request

## License

Licensed under the [GNU Affero General Public License v3.0](LICENSE)

Version data entries

1 entries across 1 versions & 1 rubygems

Version Path
technologist-0.6.0 README.md