htmltoadf 0.1.3 → 0.1.4

package/README.md

@@ -16,25 +16,30 @@ The library can be used in several different ways:
 
 ----
 
-```toml
-[dependencies]
-htmltoadf = "0.1.3"
-```
+<img src="./screenshot-light.png" width=350/><img src="./screenshot-dark.png" width=350/>
+
+----
+## Demo
+
+See demo of the tool running as a WASM library entirely in the client here:
+https://wouterken.github.io/htmltoadf/
+
+----
 
 ## CLI
 ### Binaries
 ### Install Binary from Crates.io with `cargo install`
 ```
 $ cargo install htmltoadf
-    installing htmltoadf v0.1.3 (/usr/src/html2adf)
+    installing htmltoadf v0.1.4 (/usr/src/html2adf)
     Updating crates.io index
  Downloading crates ...
   Downloaded lock_api v0.4.6
 --snip--
-      Compiling htmltoadf v0.1.3
+      Compiling htmltoadf v0.1.4
     Finished release [optimized] target(s) in 1m 42s
   Installing ~/.cargo/bin/htmltoadf
-   Installed package `htmltoadf v0.1.3` (executable `html2adf`)
+   Installed package `htmltoadf v0.1.4` (executable `html2adf`)
 ```
 
 ### Download Binary file from Github
@@ -44,15 +49,15 @@ https://github.com/wouterken/htmltoadf/releases/tag/0.1.2
 ### Docker Image
 **Docker Repo:**
 
-https://hub.docker.com/repository/docker/wouterken/html2adf
+https://hub.docker.com/r/wouterken/html2adf
 
 **Usage**
 
 ```bash
-$ echo "<h1>Hello world<p>Test</p></h1>" | docker run --rm -i wouterken/html2adf:0.1.2
+$ echo "<h1>Hello world<p>Test</p></h1>" | docker run --rm -i wouterken/html2adf:0.1.4
 {"version":1,"type":"doc","content":[{"type":"heading","attrs":{"level":1},"content":[{"type":"text","text":"Hello world"},{"type":"text","text":"Test"}]}]}
 
-$ echo "<h1>Hello world<p>Test</p></h1>" | docker run --rm -i wouterken/html2adf:0.1.2 | jq
+$ echo "<h1>Hello world<p>Test</p></h1>" | docker run --rm -i wouterken/html2adf:0.1.4 | jq
 {
   "version": 1,
   "type": "doc",
@@ -79,7 +84,17 @@ $ echo "<h1>Hello world<p>Test</p></h1>" | docker run --rm -i wouterken/html2adf
 
 ## Lib
 
-### Example Code
+### Example Rust Code
+
+**Cargo.toml**
+
+```toml
+[dependencies]
+htmltoadf = "0.1.4"
+```
+
+**Code**
+
 ```rust
 use htmltoadf::convert_html_str_to_adf_str;
 use serde_json::json;
@@ -108,20 +123,86 @@ assert_eq!(expected, converted);
 ```
 
 ### WASM
-*TODO*
+
+Install package from [npm](https://www.npmjs.com/package/htmltoadf)
+
+```javascript
+import init, {convert} from "htmltoadf";
+init()
+  .then(() => {
+    alert(convert("<h1>Hello from WebAssembly</h1>"))
+  });
+```
+
 ### FFI
-*TODO*
+First compile the code as a library, e.g.:
+
+```bash
+cargo build --lib --release
+```
+
+Then you can link to the library dynamic from any environment that supports a FFI.
+**It is important to copy the dynamic library from the release directory, and provide a relative link to the library file from the FFI**
+E.g.
+
+#### Ruby
+```ruby
+require 'ffi'
+
+module HTMLToADF
+  extend FFI::Library
+  ffi_lib 'libhtmltoadf'
+  attach_function :convert, [ :string ], :string
+end
+
+puts HTMLToADF.convert("<h1>Hello from Ruby</h1>")
+```
+
+#### Node/JavaScript
+```javascript
+var ffi = require('ffi-napi');
+
+var htmltoadf = ffi.Library('libhtmltoadf', {
+  'convert': [ 'string', [ 'string' ] ]
+});
+console.log(htmltoadf.convert("<h1>Hello from Node!</h1>"));
+
+```
+
+#### Python
+```python
+from cffi import FFI
+ffi = FFI()
+lib = ffi.dlopen("libhtmltoadf")
+ffi.cdef("char * convert(char *);")
+print(ffi.string(lib.convert(b"<h1>Hello from Python!</h1>")))
+
+```
 
 ## Implemented features
 This converter only implements a subset of possible mappings between HTML and ADF.
-The following conversions are implemented:
-* Headings
-* Images
-* Lists (ordered and unordered)
-* Tables
-* Text and Paragraphs
-* Code
-
+The following features are implemented:
+- [x] Headings
+- [x] Images
+- [x] Lists (ordered and unordered)
+- [x] Tables
+- [x] Text and Paragraphs
+- [x] Code
+- [ ] Fuzz Tests
+- [ ] Support for named CSS colors
+- [ ] Smart image sizing
+- [ ] Inline Cards
+- [ ] Panels
+- [ ] Emoji
+- [ ] In built JSON Schema Validation
+
+## Release Process
+* Increment version number in .toml and README
+* Compile binaries and create release
+* Build and push Docker image
+* Build and push WASM NPM package
+* Update dependency in demo page
+* Push to VCS
 
 ## Testing
 Run `cargo test` from the repository root.

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "htmltoadf",
   "description": "An HTML to Atlassian Document Format (ADF) converter",
-  "version": "0.1.3",
+  "version": "0.1.4",
   "license": "MIT",
   "repository": {
     "type": "git",