<commit_before># dashing-contrib

This projects is an extension to Shopify's Dashing. It aims to solve a couple of problems
 * Extend the Dashing's widgets functionality in a healthy pattern.
 * Embrace sharing, reusing, testing common jobs data manipulation functionality
 * Make it easier to work with History.yml in file and memory
 * A common way to load external configuration via dotenv
 
## Installation
Add this line to your Dashing's dashboard Gemfile:

    gem 'dashing-contrib', '~> 0.0.2'

And then execute:

    $ bundle

Add the following on top of the `config.ru`

    $: << File.expand_path('./lib', __dir__)
    require 'dashing-contrib'
    require 'dashing'
    DashingContrib.configure
    
Add these lines to `assets/javascripts/application.coffee`

    #=require dashing-contrib/assets/widgets

Add these lines to `assets/stylesheets/application.scss`

    //=require dashing-contrib/assets/widgets

## Included Widgets

 * [Rickshawgraph](https://gist.github.com/jwalton/7916168) made by [jwalton](https://gist.github.com/jwalton)

## Included Job helpers

 TODO:

## Components/Widgets made by contributors

 * [jwalton](https://gist.github.com/jwalton)<commit_msg>Added readme for contribution<commit_after># dashing-contrib

This projects is an extension to Shopify's Dashing. It aims to solve a couple of problems
 * Extend the Dashing's widgets functionality in a healthy pattern.
 * Embrace sharing, reusing, testing common jobs data manipulation functionality
 * Make it easier to work with History.yml in file and memory
 * A common way to load external configuration via dotenv
 
## Installation
Add this line to your Dashing's dashboard Gemfile:

    gem 'dashing-contrib', '~> 0.0.2'

And then execute:

    $ bundle

Add the following on top of the `config.ru`

    $: << File.expand_path('./lib', __dir__)
    require 'dashing-contrib'
    require 'dashing'
    DashingContrib.configure
    
Add these lines to `assets/javascripts/application.coffee`

    #=require dashing-contrib/assets/widgets

Add these lines to `assets/stylesheets/application.scss`

    //=require dashing-contrib/assets/widgets

## Included Widgets

 * [Rickshawgraph](https://gist.github.com/jwalton/7916168) made by [jwalton](https://gist.github.com/jwalton)

## Included Job helpers

 TODO:

## How to contribute

There are a couple of ways to contribute. Brining those widgets scattered in github, in multiple format into this repository. They usually falling into the following two categories:

### Widgets

Common widgets should be generic solution to a common requirements. e.g. line graph,better clock with common functionalities. Documentation should be written as a readme file under widget's own directory.

### Jobs utils

Common Job data processing for graphing purpose.


## Components/Widgets made by contributors

 * [jwalton](https://gist.github.com/jwalton)
{'fraction_non_alphanumeric': 0.08665511265164645, 'fraction_numerical': 0.006932409012131715, 'mean_word_length': 4.1535714285714285, 'pattern_counts': {'":': 0, '<': 7, '<?xml version=': 0, '>': 5, 'https://': 6, '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': '7160803', 'n_tokens_mistral': 863, 'n_tokens_neox': 808, 'n_words': 304}