index.html

---
layout: default
---

<section class="hero is-primary is-medium">
  <div class="hero-body">
    <div class="container has-text-centered">
      <h1 class="title is-size-1">
        Cadmium
      </h1>
      <h2 class="subtitle is-size-4">
        Natural Language Processing libraries for Crystal
      </h2>
      <a href="/guide" class="button is-light is-medium">Get Started</a>
    </div>
  </div>
</section>

<section id="description" class="section">
  <div class="container">
    <div class="columns is-centered">
      <div class="column is-8">
        <h1 class="title">About</h1>
      </div>
    </div>
    <div class="columns is-centered">
      <div class="column is-8">
        <p>
          Cadmium is a collection of NLP shards for the Crystal programming language. You can import 
          them individually from the list below, or use the <code>cadmium</code> shard itself to import them all. 
        </p>
      </div>
    </div>
  </div>
</section>

<section id="installation" class="section">
  <div class="container">
    <div class="columns is-centered">
      <div class="column is-8">
        <h1 class="title">Installation</h1>
      </div>
    </div>
    <div class="columns is-centered">
      <div class="column is-8">
        <h2 class="subtitle">Add one of the below libraries, or cadmium itself, to your <code>shard.yml</code></h2>
{% highlight yaml %}
dependencies:
  cadmium:
    github: cadmiumcr/cadmium
{% endhighlight %}
      </div>
    </div>
    <div class="columns is-centered">
      <div class="column is-8">
        <h2 class="subtitle">Then require it in your project</h2>
{% highlight ruby %}
require "cadmium"
{% endhighlight %}
      </div>
    </div>
    <div class="columns is-centered">
      <div class="column is-8">
        <div class="subtitle">Check the <a href="/guide">guide</a> for more advanced usage instructions.</div>
      </div>
    </div>
  </div>
</section>

<section id="contents" class="section">
  <div class="container">
    <div class="columns is-centered">
      <div class="column is-8">
        <h1 class="title">Shards</h1>
      </div>
    </div>
    <div class="columns is-centered">
      <div class="column is-8">
        <h2 class="subtitle">Cadmium currently contains the following shards:</h2>
      </div>
    </div>
    <div class="columns is-centered">
      <div class="column is-8">
        <ul class="contents-list">
          <li><a href="https://github.com/cadmiumcr/classifier">Classifiers</a></li>
          <li><a href="https://github.com/cadmiumcr/distance">String Distance</a></li>
          <li><a href="https://github.com/cadmiumcr/glove">GloVe</a></li>
          <li><a href="https://github.com/cadmiumcr/graph">Graphs</a></li>
          <li><a href="https://github.com/cadmiumcr/inflector">Inflectors</a></li>
          <li><a href="https://github.com/cadmiumcr/lang">Language Detection</a></li>
          <li><a href="https://github.com/cadmiumcr/lemmatizer">Lemmatizers</a></li>
          <li><a href="https://github.com/cadmiumcr/ngrams">N-Grams</a></li>
          <li><a href="https://github.com/cadmiumcr/phonetics">Phonetics</a></li>
          <li><a href="https://github.com/cadmiumcr/pos_tagger">POS Tagger</a></li>
          <li><a href="https://github.com/cadmiumcr/readability">Readability</a></li>
          <li><a href="https://github.com/cadmiumcr/sentiment">Sentiment Analysis</a></li>
          <li><a href="https://github.com/cadmiumcr/stemmer">Stemmers</a></li>
          <li><a href="https://github.com/cadmiumcr/summarizer">Summarizer</a></li>
          <li><a href="https://github.com/cadmiumcr/tfidf">Tf-Idf</a></li>
          <li><a href="https://github.com/cadmiumcr/tokenizer">Tokenizers</a></li>
          <li><a href="https://github.com/cadmiumcr/transliterator">Transliterator</a></li>
          <li><a href="https://github.com/cadmiumcr/trie">Tries</a></li>
          <li><a href="https://github.com/cadmiumcr/wordnet">Wordnet</a></li>
        </ul>
      </div>
    </div>
  </div>
</section>