Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Fill in the readme with preliminary info.

  • Loading branch information...
commit 236801eebd3b45f78d31ee085616df568898e18d 1 parent 263e303
@dakrone authored
Showing with 40 additions and 29 deletions.
  1. +0 −17 README
  2. +28 −0 README.markdown
  3. +12 −12 project.clj
View
17 README
@@ -1,17 +0,0 @@
-# cd-wsapi
-
-FIXME: write description
-
-## Usage
-
-FIXME: write
-
-## Installation
-
-FIXME: write
-
-## License
-
-Copyright (C) 2010 FIXME
-
-Distributed under the Eclipse Public License, the same as Clojure.
View
28 README.markdown
@@ -0,0 +1,28 @@
+cd-wsapi - ClojureDocs.org web API
+==================================
+
+Usage
+-----
+
+ lein uberjar
+ java -jar cd-wsapi-0.1.0-SNAPSHOT-standalone.jar
+
+In a separate terminal:
+
+Getting examples
+----------------
+
+ curl "http://localhost:8080/examples/clojure.core/map"
+
+Searching for a function
+------------------------
+
+ curl "http://localhost:8080/search/map"
+ curl "http://localhost:8080/search/clojure.core/map"
+
+License
+-------
+
+Copyright (C) 2010 FIXME
+
+Distributed under the Eclipse Public License, the same as Clojure.
View
24 project.clj
@@ -1,13 +1,13 @@
(defproject cd-wsapi "0.1.0-SNAPSHOT"
- :description "ClojureDocs External API"
- :dependencies [[org.clojure/clojure "1.2.0-RC1"]
- [org.clojure/clojure-contrib "1.2.0-RC1"]
- [mysql/mysql-connector-java "5.1.12"]
- [aleph "0.1.0-SNAPSHOT"]
- [net.cgrand/moustache "1.0.0-SNAPSHOT"]
- [org.danlarkin/clojure-json "1.1"]]
- :dev-dependencies [[leiningen/lein-swank "1.2.0-SNAPSHOT"]
- [leiningen-init-script "1.2.0-SNAPSHOT"]]
- :lis-opts {:properties {:config-clj.env "prod"}
- :redirect-output-to "/var/log/cd-wsapi.log"}
- :main main)
+ :description "ClojureDocs External API"
+ :dependencies [[org.clojure/clojure "1.2.0-RC1"]
+ [org.clojure/clojure-contrib "1.2.0-RC1"]
+ [mysql/mysql-connector-java "5.1.12"]
+ [aleph "0.1.0-SNAPSHOT"]
+ [net.cgrand/moustache "1.0.0-SNAPSHOT"]
+ [org.danlarkin/clojure-json "1.1"]]
+ :dev-dependencies [[leiningen/lein-swank "1.2.0-SNAPSHOT"]
+ [leiningen-init-script "1.2.0-SNAPSHOT"]]
+ :lis-opts {:properties {:config-clj.env "prod"}
+ :redirect-output-to "/var/log/cd-wsapi.log"}
+ :main main)
Please sign in to comment.
Something went wrong with that request. Please try again.