docs housekeeping

bortexz · Sep 30, 2022 · fd50466 · fd50466
1 parent b392c04
commit fd50466
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 5 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,9 @@
 # Change Log
 
+## 0.0.2 - 2022-09-30
+### Changed
+- `reconnector` docstring now includes `get-url` and `get-opts` docs. No functional changes.
+
 ## 0.0.1 - 2022-08-21
 
 Initial release
diff --git a/README.md b/README.md
@@ -1,7 +1,7 @@
 # resocket
 [![Clojars Project](https://img.shields.io/clojars/v/io.github.bortexz/resocket.svg)](https://clojars.org/io.github.bortexz/resocket)[![Cljdoc](https://cljdoc.org/badge/io.github.bortexz/resocket)](https://cljdoc.org/d/io.github.bortexz/resocket)
 
-WebSocket client for Clojure wrapping the JDK11 WebSocket Client.
+JDK11 Clojure WebSocket client with core.async API
 
 ## Features
 
@@ -11,16 +11,17 @@ WebSocket client for Clojure wrapping the JDK11 WebSocket Client.
 - Specify `input` and `output` parsers to take/put your preferred data structure on the channels (maps, vecs, ...) and use the parser for json/edn parsing, etc.
 - Minimal dependencies, just `clojure` and `core.async`.
 - `reconnector` process to create new connections when the previous ones have been closed, returning a core.async `connections` channel to take new connections from.
+- Small codebase, around ~300 LOC docstrings included.
 
 ## Install
 ### **Leiningen/Boot**
 ```clojure
-[io.github.bortexz/resocket "0.0.1"]
+[io.github.bortexz/resocket "0.0.2"]
 ```
 
 ### **Clojure CLI/deps.edn**
 ```clojure
-io.github.bortexz/resocket {:mvn/version "0.0.1"}
+io.github.bortexz/resocket {:mvn/version "0.0.2"}
 ```
 
 ## Usage

diff --git a/build.clj b/build.clj
@@ -3,7 +3,7 @@
   (:require [org.corfield.build :as bb]))
 
 (def lib 'io.github.bortexz/resocket)
-(def version "0.0.1")
+(def version "0.0.2")
 
 (defn- gha-output
   [k v]

diff --git a/pom-template.xml b/pom-template.xml
@@ -2,7 +2,7 @@
 <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
   <modelVersion>4.0.0</modelVersion>
   <name>resocket</name>
-  <description>Reconnectable websocket client</description>
+  <description>JDK11 Clojure WebSocket client with core.async API</description>
   <url>https://github.com/bortexz/resocket</url>
   <licenses>
     <license>