Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 58 lines (37 sloc) 1.512 kB
e4f97e0 @dakrone Initial commit
authored
1 # cd-client
2
4e18113 @jafingerhut Update the README
jafingerhut authored
3 A client for the http://clojuredocs.org API
e4f97e0 @dakrone Initial commit
authored
4
5 ## Usage
6
d97696a @dakrone Readme update.
authored
7 (use 'cd-client.core)
8
4fd3086 @jafingerhut Remove some documentation comments from core.clj and put them in READ…
jafingerhut authored
9 Examples work with strings for the ns and name, as well as just a
4e18113 @jafingerhut Update the README
jafingerhut authored
10 symbol (no quoting needed -- it will not work if you do). The symbol
11 can be of a special form (e.g. let, try, catch), macros (e.g. for,
12 areduce), or functions. Use 'cdoc' to pretty-print the normal Clojure
b939840 @jafingerhut Touch up the README
jafingerhut authored
13 doc string and the following information from clojuredocs.org:
7195980 @jafingerhut Fix typo in README
jafingerhut authored
14 examples, see-also list of symbols, and comments.
6691c56 @dakrone Bring client inline with the new WSAPI changes.
authored
15
4e18113 @jafingerhut Update the README
jafingerhut authored
16 (cdoc "clojure.core" "map")
17 (cdoc map)
18 (cdoc clojure.string/join)
6691c56 @dakrone Bring client inline with the new WSAPI changes.
authored
19
20 Search for a method using just the name or a namespace and name.
21
e4f97e0 @dakrone Initial commit
authored
22 (search "pmap")
23 (search "clojure.core" "map")
6691c56 @dakrone Bring client inline with the new WSAPI changes.
authored
24
4e18113 @jafingerhut Update the README
jafingerhut authored
25 Browse to the url for a symbol in your default browser (takes same
26 arguments as cdoc):
6691c56 @dakrone Bring client inline with the new WSAPI changes.
authored
27
4e18113 @jafingerhut Update the README
jafingerhut authored
28 (browse-to "clojure.core" "map")
29 (browse-to map)
6691c56 @dakrone Bring client inline with the new WSAPI changes.
authored
30
4e18113 @jafingerhut Update the README
jafingerhut authored
31 By default, all of the above will query the clojuredocs web site for
32 the results. As an option, you can load a 'snapshot file' of saved
33 results, available in the github repository, and no Internet access is
34 required (except for browse-to target pages, which still require
35 Internet access).
6691c56 @dakrone Bring client inline with the new WSAPI changes.
authored
36
4e18113 @jafingerhut Update the README
jafingerhut authored
37 (set-local-mode! "clojuredocs-snapshot-2011-12-03.txt")
6691c56 @dakrone Bring client inline with the new WSAPI changes.
authored
38
4e18113 @jafingerhut Update the README
jafingerhut authored
39 You can switch back to web mode with (set-web-mode!) or show the
40 current mode with (show-mode).
e4f97e0 @dakrone Initial commit
authored
41
6718423 @dakrone Add leiningen line to README.
authored
42 ## As a dependency:
43
44 For Leiningen:
45
e556a5d @dakrone Release 0.3.6
authored
46 [org.thnetos/cd-client "0.3.6"]
6718423 @dakrone Add leiningen line to README.
authored
47
e4f97e0 @dakrone Initial commit
authored
48 ## Installation
49
6691c56 @dakrone Bring client inline with the new WSAPI changes.
authored
50 lein deps
e4f97e0 @dakrone Initial commit
authored
51 lein jar
52
53 ## License
54
55 Copyright (C) 2010 Lee Hinman
56
57 Distributed under the Eclipse Public License, the same as Clojure.
Something went wrong with that request. Please try again.