<commit_before># Buckygem

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

A gem for random ruby utilities.

## Installation

Add this line to your application's Gemfile:

    gem 'buckygem'

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install buckygem

## Usage

### Scan a directory to find images

To get an `Array` of the absolute paths of images contained in folder with the relative path `foo`:

    images_collection = Buckygem::ImagesCollection.new("foo")
    images_collection.images

### Get image metadata in a LESS format

To get dimensions of an image located at the relative path `foo.png`:
<commit_msg>docs: update documentation to make it clear that buckygem is now a Jekyll plugin<commit_after># Buckygem

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

Buckygem is a Jekyll plugin tighly linked to the [Kids theme](https://github.com/dirtyhenry/kids).

## Installation

Add this line to your application's Gemfile:

    gem 'buckygem'

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install buckygem

## Usage

### Scan a directory to find images

To get an `Array` of the absolute paths of images contained in folder with the relative path `foo`:

    images_collection = Buckygem::ImagesCollection.new("foo")
    images_collection.images

### Get image metadata in a LESS format

To get dimensions of an image located at the relative path `foo.png`:

{'fraction_non_alphanumeric': 0.09229789942711648, 'fraction_numerical': 0.0, 'mean_word_length': 4.24, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 5, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '5052223', 'n_tokens_mistral': 494, 'n_tokens_neox': 467, 'n_words': 176}