Skip to content

Commit 871c2d7

Browse files
committed
readme updates
1 parent e278dde commit 871c2d7

File tree

2 files changed

+8
-5
lines changed

2 files changed

+8
-5
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,3 +13,4 @@ pom.xml
1313
.settings
1414

1515
.externalToolBuilders
16+
.repl

README.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# url [![Travis CI status](https://secure.travis-ci.org/cemerick/url.png)](http://travis-ci.org/#!/cemerick/url/builds)
22

3-
This is a library that makes working with URLs in Clojure a little more
4-
pleasant.
3+
This is a library that makes working with URLs in Clojure and ClojureScript a
4+
little more pleasant.
55

66
## "Installation"
77

@@ -27,7 +27,9 @@ Or, add this to your Maven project's `pom.xml`:
2727
</dependency>
2828
```
2929

30-
url is compatible with Clojure 1.2.0 - 1.5.0.
30+
Starting with version `0.1.0`, url requires Clojure >= 1.5.0. It provides the
31+
same API under ClojureScript (tested with ClojureScript `0.0-1835`, and should
32+
work well with any later revision).
3133

3234
## Usage
3335

@@ -36,7 +38,7 @@ The `cemerick.url/url` function returns an instance of the
3638
datum within the provided URL:
3739

3840
```clojure
39-
=> (use '[cemerick.url :only (url url-encode)])
41+
=> (require '[cemerick.url :refer (url url-encode)])
4042
nil
4143
=> (-> (url "https://api.stripe.com/v1/charges")
4244
(assoc :username "vtUQeOtUnYr7PGCLQ96Ul4zqpDUO4sOE")
@@ -50,7 +52,7 @@ in the base URL:
5052
```clojure
5153
=> (url "https://api.twitter.com/")
5254
#cemerick.url.URL{:protocol "https", :username nil, :password nil,
53-
:host "api.twitter.com", :port -1, :path nil, :query nil,
55+
:host "api.twitter.com", :port -1, :path "/", :query nil,
5456
:anchor nil}
5557
=> (url "https://api.twitter.com/" "1" "users" "profile_image" "cemerick")
5658
#cemerick.url.URL{:protocol "https", :username nil, :password nil,

0 commit comments

Comments
 (0)