Skip to content

Latest commit

 

History

History
202 lines (167 loc) · 6.35 KB

index.markdown

File metadata and controls

202 lines (167 loc) · 6.35 KB
Raw
layout title
default
argonaut
Argonaut
Purely Functional JSON in Scala
Getting Started

The current published version of argonaut is {{ site.release }} and is available on https://oss.sonatype.org.

Depending on argonaut with sbt, stable:

"io.argonaut" %% "argonaut" % "{{ site.release }}"     
"io.argonaut" %% "argonaut-scalaz" % "{{ site.release }}"  
"io.argonaut" %% "argonaut-monocle" % "{{ site.release }}"  
"io.argonaut" %% "argonaut-cats" % "{{ site.release }}"  
      <p>
        Then checkout the <a href="/doc/quickstart">quickstart</a>,
        <a href="/doc">the detailed documention and examples</a>, and
        the <a href="scaladocs/">scaladocs</a>.
      </p>

      <p>
        The 6.2.x release supports scala 2.10.*, 2.11.* and 2.12.* with scalaz 7.2.*.
      </p>

      <p>
        All minor releases (from 6.0 onwards) are binary compatible, i.e. 6.1.x stream are drop in replacements, and the same will be true for 6.2.x, but
        going from 6.1 to 6.2 _may_ require changes or recompilation.
      </p>

      <p>Release Notes:
        {% for note in site.notes %}
        <a href="https://github.com/argonaut-io/argonaut/blob/master/notes/{{ note }}.markdown">[{{ note }}]</a>
        {% endfor %}
      </p>

    </div>


  </div>
  <div id="help" class="section">
    <div class="title">Features</div>
    <div class="details">
Concise Codec Definitions #
import argonaut., Argonaut.


case class Person(name: String, age: Int, things: List[String])


implicit def PersonCodecJson =
casecodec3(Person.apply, Person.unapply)("name", "age", "things")
Rich library for Parsing, Printing, Conversion and Manipulation #
val person =
    Person("Bam Bam", 2, List("club"))

val json: Json =
    person.asJson

val prettyprinted: String =
    json.spaces2

val parsed: Option[Person] =
    prettyprinted.decodeOption[Person]
History Preserving Zipper #
val cursor =
json.hcursor --\ "field" --\ "nested" --\ "deep" := "new value"


val history =
cursor.history


val updated =
-cursor


<script type="text/javascript">
  prettyPrint();
</script>

    </div>
  </div>

  <div id="help" class="section">
    <div class="title">Getting Help</div>
    <div class="details">
      <p>
        We have an irc channel on freenode - <strong>#argonaut</strong>
      </p>
      <ul>
        <li>IRC Client: <a href="irc://freenode.net/#argonaut">irc://freenode.net/#argonaut</a></li>
        <li>Web Access: <a href="http://webchat.freenode.net/?channels=argonaut">http://webchat.freenode.net/?channels=argonaut</a></li>
      </ul>
      <p>
        Contact one of the developers on twitter: <br/>
        <a href="https://twitter.com/dibblego">@dibblego</a>
        <a href="https://twitter.com/seanparsons">@seanparsons</a>

      </p>
      <p>
        Mailing list:
        <a href="https://groups.google.com/forum/?fromgroups#!forum/argonaut-json">argonaut-json</a> on google groups.
      </p>

    </div>
  </div>

  <div id="source" class="section">
    <div class="title">Source Code</div>
    <div class="details">
      <p>
        You can grab the source code from the github repository at <a href="https://github.com/argonaut-io/argonaut">https://github.com/argonaut-io/argonaut</a>
      </p>
      <p>
        The project is built with <a href="http://www.scala-sbt.org/">sbt</a>. Just run the sbt script in the root
        of the project:
      </p>
      <pre>$ ./sbt compile</pre>
    </div>
  </div>

  <div id="contributing" class="section">
    <div class="title">Contributing</div>
    <div class="details">
      <p>
        All contributions are very welcome. Just fork and
        <a href="https://help.github.com/articles/using-pull-requests">create a pull request</a> on github.
      </p>
      <p>
        To make it easier for us to pull in your changes, try to:
      </p>
      <ul>
        <li>Make a new pull request for each logical change.</li>
        <li>Make each pull request a single coherent commit. Use <code>git rebase -i</code> to squash commits as necessary.</li>
        <li>Add tests if you are adding functionality or fixing a bug.</li>
        <li>Run the tests on all versions of scala using <code>./sbt "+test"</code>.</li>
      </ul>
    </div>
  </div>


  <div id="developers" class="section">
    <div class="title">Developers</div>
    <div class="details">
      <div>
        <h6>Tony Morris</h6>
        <p>
          <a href="https://twitter.com/dibblego">@dibblego</a><br />
          <a href="http://tmorris.net">http://tmorris.net</a>
        </p>
      </div>
      <div>
        <h6>Sean Parsons</h6>
        <p>
          <a href="https://twitter.com/seanparsons">@seanparsons</a>
        </p>
      </div>
    </div>
  </div>

  <div id="thankyou" class="section">
    <div class="title">Thanks</div>
    <div class="details">
      <h6>YourKit</h6>
      <p id="thanksyourkit">
        YourKit is kindly supporting argonaut and other open source projects with its
        full-featured <a href="http://www.yourkit.com/java/profiler/index.jsp">Java Profiler</a>.
      </p>
      <h6>Ephox</h6>
      <p>
        Argonaut was orginally conceived, developed and open sourced by
        <a href="http://ephox.com/">Ephox</a>.
      </p>
    </div>
  </div>
</div>