Skip to content

mochify/hiroba

Repository files navigation

Hiroba, a Clojure client for Foursquare

Hiroba is a minimalistic Clojure client for the Foursquare REST API.

This is not the first Clojure client for Foursquare, but it strives to be the best documented and most complete. The other pre-existing Clojure Foursquare clients available are:

Project Goals

  • Be feature complete with the Foursquare API
  • Be well documented
  • Be well tested
  • Be Clojuric, relying on Clojure idioms without introducing unnecessary abstractions
  • Don't be subject to NIH Syndrome
  • Be up-to-date with the latest Foursquare API changes

Project Maturity

Hiroba is in its infancy. It is a new project, with only minimal use in production and testing environments at this point. The API is subject to change at any time, but will stabilize over time.

Recent changes

Please see the most recent changelog.

Artifacts

Hiroba artifacts are released to Clojars. If you are using Maven, add the following repository definition to your pom.xml:

<repository>
  <id>clojars.org</id>
  <url>http://clojars.org/repo</url>
</repository>

The Most Recent Release

With Leiningen:

[com.mochify/hiroba "0.1.0-alpha"]

With Maven:

<dependency>
  <groupId>com.mochify</groupId>
  <artifactId>hiroba</artifactId>
  <version>0.1.0-SNAPSHOT</version>
</dependency>

Documentation & Examples

For the latest documentation, please see Hiroba's documentation site.

Supported Clojure versions

Hiroba is developed against Clojure 1.5.0 and newer. Use of the latest version is recommended.

Continuous Integration Status

Continuous Integration status

Development

Hiroba uses Leiningen 2. Make sure you have it installed and then run tests against supported Clojure versions using

lein2 test

Then create a branch and make your changes on it. Once you are done with your changes and all tests pass, submit a pull request on GitHub.

License

Copyright (C) 2014 William Lee, Alex Kuang, and The Mochify Team.

Licensed under the Apache Public License 2.0.