godash-diagrams 0.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md ADDED
@@ -0,0 +1,52 @@
1
+ # Godash Diagrams
2
+
3
+ A diagramming library for [Go](https://en.wikipedia.org/wiki/Go_(game)), inspired by [Mermaid](https://mermaid.js.org/), and built on [Godash](https://duckpunch.github.io/godash/).
4
+
5
+ [**Try it live →**](https://duckpunch.github.io/godash-diagrams/)
6
+
7
+ ## Installation
8
+
9
+ ```bash
10
+ npm install godash-diagrams
11
+ ```
12
+
13
+ ## Usage
14
+
15
+ ```javascript
16
+ import { init } from 'godash-diagrams'
17
+
18
+ init('#app', {
19
+ diagramSource: `static
20
+
21
+ . . . . . . . . .
22
+ . . . . . . . . .
23
+ . . + . . . + . .
24
+ . . . O . . . . .
25
+ . . . O X X . . .
26
+ . . X X O . . . .
27
+ . . + . O . + . .
28
+ . . . . . . . . .
29
+ . . . . . . . . .
30
+ `
31
+ })
32
+ ```
33
+
34
+ ### Plain HTML
35
+
36
+ ```html
37
+ <script src="https://unpkg.com/godash-diagrams"></script>
38
+ <div id="app"></div>
39
+ <script>
40
+ GodashDiagrams.init('#app', {
41
+ diagramSource: `static
42
+
43
+ O .
44
+ . X
45
+ `
46
+ })
47
+ </script>
48
+ ```
49
+
50
+ ## License
51
+
52
+ ISC