Permalink
Browse files

move changelog and api documentation out of readme, to their own files

  • Loading branch information...
1 parent 5aaf03e commit 3ecd57574460e370a57fb8a9a68d81fbf29c02f0 @Bronsa Bronsa committed Nov 19, 2013
Showing with 110 additions and 106 deletions.
  1. +41 −0 API.md
  2. +49 −0 CHANGELOG.md
  3. +20 −106 README.md
View
41 API.md
@@ -0,0 +1,41 @@
+Public API
+========================================
+
+There are four public namespaces:
+* [clojure.tools.reader.reader-types](http://clojure.github.com/tools.reader/index.html#clojure.tools.reader.reader-types) offers protocols, implementations and convenient function helpers for some reader types.
+ * Protocols:
+ * [Reader](http://clojure.github.com/tools.reader/index.html#clojure.tools.reader.reader-types/Reader) ([read-char](http://clojure.github.com/tools.reader/index.html#clojure.tools.reader.reader-types/read-char), [peek-char](http://clojure.github.com/tools.reader/index.html#clojure.tools.reader.reader-types/peek-char))
+ * [IPushbackReader](http://clojure.github.com/tools.reader/index.html#clojure.tools.reader.reader-types/IPushbackReader) ([unread](http://clojure.github.com/tools.reader/index.html#clojure.tools.reader.reader-types/unread))
+ * [IndexingReader](http://clojure.github.com/tools.reader/index.html#clojure.tools.reader.reader-types/IndexingReader) ([get-line-number](http://clojure.github.com/tools.reader/index.html#clojure.tools.reader.reader-types/get-line-number), [get-column-number](http://clojure.github.com/tools.reader/index.html#clojure.tools.reader.reader-types/get-column-number))
+ * Types:
+ * [StringReader](http://clojure.github.com/tools.reader/index.html#clojure.tools.reader.reader-types/StringReader)
+ * [PushbackReader](http://clojure.github.com/tools.reader/index.html#clojure.tools.reader.reader-types/PushbackReader)
+ * [IndexingPushbackReader](http://clojure.github.com/tools.reader/index.html#clojure.tools.reader.reader-types/IndexingPushbackReader)
+ * [InputStreamReader](http://clojure.github.com/tools.reader/index.html#clojure.tools.reader.reader-types/InputStreamReader)
+ * Types Constructor Functions:
+ * [string-reader](http://clojure.github.com/tools.reader/index.html#clojure.tools.reader.reader-types/string-reader)
+ * [string-push-back-reader](http://clojure.github.com/tools.reader/index.html#clojure.tools.reader.reader-types/string-push-back-reader)
+ * [indexing-push-back-reader](http://clojure.github.com/tools.reader/index.html#clojure.tools.reader.reader-types/indexing-push-back-reader)
+ * [input-stream-reader](http://clojure.github.com/tools.reader/index.html#clojure.tools.reader.reader-types/input-stream-reader)
+ * [input-stream-push-back-reader](http://clojure.github.com/tools.reader/index.html#clojure.tools.reader.reader-types/input-stream-push-back-reader)
+ * Functions:
+ * [read-line](http://clojure.github.com/tools.reader/index.html#clojure.tools.reader.reader-types/read-line)
+ * [reader-error](http://clojure.github.com/tools.reader/index.html#clojure.tools.reader.reader-types/reader-error)
+* [clojure.tools.reader.edn](http://clojure.github.com/tools.reader/index.html#clojure.tools.reader.edn) offers a feature-complete EDN reader, whose API matches clojure.edn's one, those functions are *safe*.
+ * Functions:
+ * [read](http://clojure.github.com/tools.reader/index.html#clojure.tools.reader.edn/read)
+ * [read-string](http://clojure.github.com/tools.reader/index.html#clojure.tools.reader.edn/read-string)
+* [clojure.tools.reader](http://clojure.github.com/tools.reader/index.html#toc0) offers a feature-complete clojure reader, whose API matches clojure.core's one, those functions are *unsafe* and may allow code execution if not used properly.
+ * Functions:
+ * [read](http://clojure.github.com/tools.reader/index.html#clojure.tools.reader/read)
+ * [read-string](http://clojure.github.com/tools.reader/index.html#clojure.tools.reader/read-string)
+ * Macros:
+ * syntax-quote
+ * Vars:
+ * [\*read-eval\*](http://clojure.github.com/tools.reader/index.html#clojure.tools.reader/*read-eval*)
+ * [\*data-readers\*](http://clojure.github.com/tools.reader/index.html#clojure.tools.reader/*data-readers*)
+ * [\*default-data-reader-fn\*](http://clojure.github.com/tools.reader/index.html#clojure.tools.reader/*default-data-reader-fn*)
+ * [default-data-readers](http://clojure.github.com/tools.reader/index.html#clojure.tools.reader/default-data-readers)
+* [clojure.tools.reader.default-data-readers](http://clojure.github.com/tools.reader/index.html#clojure.tools.reader.default-data-readers) offers implementations for the #inst and #uuid tagged literals, copied from the clojure source.
+
+Refer to docstrings in each namespace and to the project's [autodoc](http://clojure.github.com/tools.reader/index.html) for more documentation.
View
@@ -0,0 +1,49 @@
+Changelog
+========================================
+
+* Release 0.7.10 on Oct 24, 2013
+ * Add \*alias-map\*
+* Release 0.7.9 on Oct 11, 2013
+ * Fixed \r\n handling
+* Release 0.7.8 on Sep 27, 2013
+ * Added missing whitespace in exception message
+ * Added get-file-name to IndexingReader
+* Release 0.7.7 on Sep 13, 2013
+ * Fixed #TRDR-8
+ * Fixed out-of-bound exception in ctor-reader args mismatch
+* Release 0.7.6 on Aug 14, 2013
+ * Fixed #TRDR-7
+* Release 0.7.5 on Jun 03, 2013
+ * Removed all reflection for clojure 1.3
+ * Fixed :column metadata handling on symbols
+* Release 0.7.4 on Apr 19, 2013
+ * Fixed docstrings position and typos
+ * Fixed a bug that would have prevented future alpha versions of clojure to have column metadata
+ * Made symbols containing two consecutive ':' illegal, as per [clojure.org](http://clojure.org/reader#The%20Reader--Reader%20forms)
+ * Made symbols containing two consecutive '/' illegal
+ * Removed reflection warnings
+* Release 0.7.3 on Mar 08, 2013
+ * AOT compile only ExceptionInfo.
+* Release 0.7.2 on Mar 02, 2013
+ * Fixed evaling read objects for clojure 1.5
+* Release 0.7.1 on Mar 02, 2013
+ * Added the syntax-quote macro to the public API
+* Release 0.7.0 on Feb 14, 2013
+ * Fixed #TRDR-1 by @jafingerhut
+ * Made compatible with clojure-1.3.0
+ * Decoupled from clojure.core vars (\*read-eval\*, \*default-data-reader-fn\*, \*data-readers\*)
+ * clojure.tools.reader/read-string and clojure.tools.reader.edn/read-string return nil if string is nil or empty
+ * Added comprehensive docstrings
+* Release 0.6.5 on Feb 09, 2013
+ * Fixed reading \@ \~ and \`
+* Release 0.6.4 on Feb 08, 2013
+ * Fix Unicode char reading
+ * Add \*default-data-reader-fn\* support
+ * Add an EDN-only reader
+ * Disable record literals reading when \*read-eval\* is bound to false
+ * Made \% a symbol constituent char
+ * Made the EDN reader API match the clojure.edn one
+* Release 0.6.2 on Feb 04, 2013
+ * Add line/column metadata on vectors, maps and symbols
+* Release 0.6.0 on Feb 03, 2013
+ * Initial release.
View
126 README.md
@@ -4,12 +4,12 @@ clojure.tools.reader
A complete Clojure reader and an EDN-only reader, works with Clojure versions >= 1.3.0
* [Rationale](#rationale)
-* [Public API](#public-api)
* [Releases and Dependency Information](#releases-and-dependency-information)
-* [Example Usage](#example-usage)
-* [Differences from LispReader.java](#differences-from-lispreaderjava)
* [Changelog](#changelog)
* [Developer Information](#developer-information)
+* [Public API](#public-api)
+* [Example Usage](#example-usage)
+* [Differences from LispReader.java](#differences-from-lispreaderjava)
* [License](#license)
Rationale
@@ -26,48 +26,6 @@ Moreover, by using reader types from `clojure.tools.reader.reader-types`, if usi
Note that it uses `ex-info` which is available on `clojure.core` only from clojure-1.4.0.
If using clojure-1.3.0 and needing access to ex-data, use `clojure.tools.reader.impl.utils/ex-data`
-Public API
-========================================
-
-There are four public namespaces:
-* [clojure.tools.reader.reader-types](http://clojure.github.com/tools.reader/index.html#clojure.tools.reader.reader-types) offers protocols, implementations and convenient function helpers for some reader types.
- * Protocols:
- * [Reader](http://clojure.github.com/tools.reader/index.html#clojure.tools.reader.reader-types/Reader) ([read-char](http://clojure.github.com/tools.reader/index.html#clojure.tools.reader.reader-types/read-char), [peek-char](http://clojure.github.com/tools.reader/index.html#clojure.tools.reader.reader-types/peek-char))
- * [IPushbackReader](http://clojure.github.com/tools.reader/index.html#clojure.tools.reader.reader-types/IPushbackReader) ([unread](http://clojure.github.com/tools.reader/index.html#clojure.tools.reader.reader-types/unread))
- * [IndexingReader](http://clojure.github.com/tools.reader/index.html#clojure.tools.reader.reader-types/IndexingReader) ([get-line-number](http://clojure.github.com/tools.reader/index.html#clojure.tools.reader.reader-types/get-line-number), [get-column-number](http://clojure.github.com/tools.reader/index.html#clojure.tools.reader.reader-types/get-column-number))
- * Types:
- * [StringReader](http://clojure.github.com/tools.reader/index.html#clojure.tools.reader.reader-types/StringReader)
- * [PushbackReader](http://clojure.github.com/tools.reader/index.html#clojure.tools.reader.reader-types/PushbackReader)
- * [IndexingPushbackReader](http://clojure.github.com/tools.reader/index.html#clojure.tools.reader.reader-types/IndexingPushbackReader)
- * [InputStreamReader](http://clojure.github.com/tools.reader/index.html#clojure.tools.reader.reader-types/InputStreamReader)
- * Types Constructor Functions:
- * [string-reader](http://clojure.github.com/tools.reader/index.html#clojure.tools.reader.reader-types/string-reader)
- * [string-push-back-reader](http://clojure.github.com/tools.reader/index.html#clojure.tools.reader.reader-types/string-push-back-reader)
- * [indexing-push-back-reader](http://clojure.github.com/tools.reader/index.html#clojure.tools.reader.reader-types/indexing-push-back-reader)
- * [input-stream-reader](http://clojure.github.com/tools.reader/index.html#clojure.tools.reader.reader-types/input-stream-reader)
- * [input-stream-push-back-reader](http://clojure.github.com/tools.reader/index.html#clojure.tools.reader.reader-types/input-stream-push-back-reader)
- * Functions:
- * [read-line](http://clojure.github.com/tools.reader/index.html#clojure.tools.reader.reader-types/read-line)
- * [reader-error](http://clojure.github.com/tools.reader/index.html#clojure.tools.reader.reader-types/reader-error)
-* [clojure.tools.reader.edn](http://clojure.github.com/tools.reader/index.html#clojure.tools.reader.edn) offers a feature-complete EDN reader, whose API matches clojure.edn's one, those functions are *safe*.
- * Functions:
- * [read](http://clojure.github.com/tools.reader/index.html#clojure.tools.reader.edn/read)
- * [read-string](http://clojure.github.com/tools.reader/index.html#clojure.tools.reader.edn/read-string)
-* [clojure.tools.reader](http://clojure.github.com/tools.reader/index.html#toc0) offers a feature-complete clojure reader, whose API matches clojure.core's one, those functions are *unsafe* and may allow code execution if not used properly.
- * Functions:
- * [read](http://clojure.github.com/tools.reader/index.html#clojure.tools.reader/read)
- * [read-string](http://clojure.github.com/tools.reader/index.html#clojure.tools.reader/read-string)
- * Macros:
- * syntax-quote
- * Vars:
- * [\*read-eval\*](http://clojure.github.com/tools.reader/index.html#clojure.tools.reader/*read-eval*)
- * [\*data-readers\*](http://clojure.github.com/tools.reader/index.html#clojure.tools.reader/*data-readers*)
- * [\*default-data-reader-fn\*](http://clojure.github.com/tools.reader/index.html#clojure.tools.reader/*default-data-reader-fn*)
- * [default-data-readers](http://clojure.github.com/tools.reader/index.html#clojure.tools.reader/default-data-readers)
-* [clojure.tools.reader.default-data-readers](http://clojure.github.com/tools.reader/index.html#clojure.tools.reader.default-data-readers) offers implementations for the #inst and #uuid tagged literals, copied from the clojure source.
-
-Refer to docstrings in each namespace and to the project's [autodoc](http://clojure.github.com/tools.reader/index.html) for more documentation.
-
Releases and Dependency Information
========================================
@@ -92,6 +50,23 @@ Latest stable release: 0.7.10
</dependency>
```
+[Changelog](CHANGELOG.md)
+========================================
+
+Developer Information
+========================================
+
+* [GitHub project](https://github.com/clojure/tools.reader)
+
+* [Bug Tracker](http://dev.clojure.org/jira/browse/TRDR)
+
+* [Continuous Integration](http://build.clojure.org/job/tools.reader/)
+
+* [Compatibility Test Matrix](http://build.clojure.org/job/tools.reader-test-matrix/)
+
+[Public API](API.md)
+========================================
+
Example Usage
========================================
@@ -194,67 +169,6 @@ Except for this special case, `read` throws an exception if a symbol contains mo
* `clojure.tools.reader/read` adds additional line/column info to symbols, vectors and maps when possible
* `clojure.tools.reader.reader-types/read-line` has an additional arity with which is possible to specify the reader to read from
-Changelog
-========================================
-
-* Release 0.6.0 on Feb 03, 2013
- * Initial release.
-* Release 0.6.2 on Feb 04, 2013
- * Add line/column metadata on vectors, maps and symbols
-* Release 0.6.4 on Feb 08, 2013
- * Fix Unicode char reading
- * Add \*default-data-reader-fn\* support
- * Add an EDN-only reader
- * Disable record literals reading when \*read-eval\* is bound to false
- * Made \% a symbol constituent char
- * Made the EDN reader API match the clojure.edn one
-* Release 0.6.5 on Feb 09, 2013
- * Fixed reading \@ \~ and \`
-* Release 0.7.0 on Feb 14, 2013
- * Fixed #TRDR-1 by @jafingerhut
- * Made compatible with clojure-1.3.0
- * Decoupled from clojure.core vars (\*read-eval\*, \*default-data-reader-fn\*, \*data-readers\*)
- * clojure.tools.reader/read-string and clojure.tools.reader.edn/read-string return nil if string is nil or empty
- * Added comprehensive docstrings
-* Release 0.7.1 on Mar 02, 2013
- * Added the syntax-quote macro to the public API
-* Release 0.7.2 on Mar 02, 2013
- * Fixed evaling read objects for clojure 1.5
-* Release 0.7.3 on Mar 08, 2013
- * AOT compile only ExceptionInfo.
-* Release 0.7.4 on Apr 19, 2013
- * Fixed docstrings position and typos
- * Fixed a bug that would have prevented future alpha versions of clojure to have column metadata
- * Made symbols containing two consecutive ':' illegal, as per [clojure.org](http://clojure.org/reader#The%20Reader--Reader%20forms)
- * Made symbols containing two consecutive '/' illegal
- * Removed reflection warnings
-* Release 0.7.5 on Jun 03, 2013
- * Removed all reflection for clojure 1.3
- * Fixed :column metadata handling on symbols
-* Release 0.7.6 on Aug 14, 2013
- * Fixed #TRDR-7
-* Release 0.7.7 on Sep 13, 2013
- * Fixed #TRDR-8
- * Fixed out-of-bound exception in ctor-reader args mismatch
-* Release 0.7.8 on Sep 27, 2013
- * Added missing whitespace in exception message
- * Added get-file-name to IndexingReader
-* Release 0.7.9 on Oct 11, 2013
- * Fixed \r\n handling
-* Release 0.7.10 on Oct 24, 2013
- * Add \*alias-map\*
-
-Developer Information
-========================================
-
-* [GitHub project](https://github.com/clojure/tools.reader)
-
-* [Bug Tracker](http://dev.clojure.org/jira/browse/TRDR)
-
-* [Continuous Integration](http://build.clojure.org/job/tools.reader/)
-
-* [Compatibility Test Matrix](http://build.clojure.org/job/tools.reader-test-matrix/)
-
## License
Copyright © Nicola Mometto, Rich Hickey & contributors.

0 comments on commit 3ecd575

Please sign in to comment.