Skip to content
This repository was archived by the owner on Apr 16, 2021. It is now read-only.

Commit b961aaf

Browse files
author
David Orme
committed
Modernized README; added Leining/Maven coordinates
1 parent 39b913b commit b961aaf

File tree

1 file changed

+27
-23
lines changed

1 file changed

+27
-23
lines changed

README.md

+27-23
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,12 @@
22

33
Clojure-navigation contains utilities for navigating data and/or code. For example:
44

5-
* Mount a data structure and navigate it with filesystem-like commands. Each appropriate command
6-
pretty-prints the first 20 rows of the current data structure. Data structure listings are automatically
7-
paged so you're less likely to blow up your REPL by inadvertently listing a huge data structure.
8-
At the same time, the current object pointed-to by the (pwd) is always available so you can
5+
## Mount a data structure and navigate it with filesystem-like commands.
6+
7+
* Each appropriate command pretty-prints the first 20 rows of the current data structure.
8+
* Data structure listings are automatically paged so you're less likely to blow up your REPL
9+
by inadvertently listing a huge data structure.
10+
* At the same time, the current object pointed-to by the (pwd) is always available so you can
911
map, mapcat, reduce, and grep the actual objects to your heart's content.
1012

1113
```clojure
@@ -18,7 +20,7 @@ map, mapcat, reduce, and grep the actual objects to your heart's content.
1820
(current :sub1 :sub2 ...) ; return the object referenced by :sub1 and :sub2 from (current)
1921
```
2022

21-
* Duck-typed Grep for deeply recursively nested data structures.
23+
## Duck-typed Grep for deeply recursively nested data structures.
2224

2325
Generally:
2426

@@ -42,13 +44,15 @@ In this case, grep searched a data structure that reports differences between tw
4244
This run determined that there were no differences found under (current).
4345

4446

45-
* A pipe operator that can map, mapcat, and reduce a collection in Unix-style.
47+
## A pipe operator that can map, mapcat, and reduce a collection in Unix-style.
4648

4749
```clojure
4850
(| (range 50) inc #(/ % 2) +)
4951
```
5052

51-
* Inject behavior before/after/around all forms in a do-style block or thread-last
53+
## Behavior injection
54+
55+
Inject behavior before/after/around all forms in a do-style block or thread-last
5256
macro form (experimental).
5357

5458
For example:
@@ -70,30 +74,30 @@ Returns a vector containing all forms converted into 0-arg functions. These fun
7074
can be executed during a map, mapcat, or reduce operation and their results stored, further
7175
processed, logged, etc.
7276

73-
## Usage
77+
### Leiningen coordinates
7478

75-
Open project.clj and change the line that reads:
79+
```clojure
80+
:repositories [["jitpack" "https://jitpack.io"]]
7681

82+
:dependencies [[com.github.shopsmart/clojure-navigation "[![Release](http://jitpack.io/v/com.github.shopsmart/clojure-navigation.svg)](https://jitpack.io/#shopsmart/clojure-navigation)"]]
7783
```
78-
:repositories [["snapshots" {:url "file:/Users/dorme/.m2/repository/"
79-
```
80-
81-
to point to your local Maven repository
8284

83-
Build using
85+
### Maven coordinates
8486

87+
```xml
88+
<repositories>
89+
<repository>
90+
<id>jitpack.io</id>
91+
<name>Jitpack repo</name>
92+
<url>https://jitpack.io</url>
93+
</repository>
94+
</repositories>
8595
```
86-
lein jar
87-
lein deploy snapshots
88-
```
89-
90-
Then depend on it in Leiningen using:
9196

92-
```
93-
[com.bradsdeals/clojure-navigation "1.0.0-SNAPSHOT"]
94-
```
97+
* GroupId: com.github.shopsmart
98+
* ArtifactId: clojure-navigation
99+
* Version: [![Release](http://jitpack.io/v/com.github.shopsmart/clojure-navigation.svg)](https://jitpack.io/#shopsmart/clojure-navigation)
95100

96-
TODO: Add clojars information once we have an official build.
97101

98102
## License
99103

0 commit comments

Comments
 (0)