paperwork

Author: barelyhuman

LICENSE

@@ -0,0 +1,20 @@
+MIT License
+
+Copyright (c) 2023 reaper (https://reaper.is) <[email protected]>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -1,3 +1,61 @@
 # arrow-render-to-string
 
-Utils to use arrow-js to render and hydrate from a server rendered environment
+Render [ArrowJS](http://arrow-js.com) templates and partials to string.
+
+Works wherever JS does.
+
+## Installation
+
+```bash
+npm install arrow-render-to-string
+```
+
+## Usage/Examples
+
+### Basic
+
+```javascript
+import { html } from '@arrow-js/core'
+import { renderToString } from 'arrow-render-to-string'
+
+const message = 'Hello World'
+const view = html`<p>${message}</p>`
+
+renderToString(view) //=> <p>Hello World</p>
+```
+
+### Reactive Variables
+
+```javascript
+import { html, reactive } from '@arrow-js/core'
+import { renderToString } from 'arrow-render-to-string'
+
+const state = reactive({
+  count: 0,
+})
+const view = html`<p>${() => state.count}</p>`
+
+renderToString(view) //=> <p>0</p>
+```
+
+### Events
+
+Events are stripped out, for you to re-hydrate on the client
+
+```javascript
+import { html, reactive } from '@arrow-js/core'
+import { renderToString } from 'arrow-render-to-string'
+
+const state = reactive({
+  count: 0,
+})
+const view = html`<button @click="${() => (state.count += 1)}">
+  ${() => state.count}
+</button>`
+
+renderToString(view) //=> <button @click="<!--➳❍-->">0</button>
+```
+
+## License
+
+[MIT](/LICENSE)