Skip to content

Commit 9eb5b22

Browse files
committed
Added Deno README
1 parent 57db770 commit 9eb5b22

File tree

1 file changed

+72
-0
lines changed

1 file changed

+72
-0
lines changed

Source/README.md

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
2+
<br>
3+
4+
<div align = center>
5+
6+
[![Badge Commit]][GitHub]   
7+
[![Badge License]][License]   
8+
[![Badge Stars]][GitHub]
9+
10+
<br>
11+
<br>
12+
13+
# GRAPH
14+
15+
*Encoder / Decoder for  `.graph` files.*
16+
17+
<br>
18+
19+
[![Button Examples]][Examples]   
20+
[![Button Documentation]][Documentation]
21+
22+
<br>
23+
<br>
24+
25+
## Preview
26+
27+
<br>
28+
29+
```JavaScript
30+
import * as Graph from 'https://deno.land/x/graph/mod.ts';
31+
```
32+
33+
</div>
34+
35+
<br>
36+
37+
```JavaScript
38+
const text = await Deno.readTextFile('Example.graph');
39+
40+
const graph = Graph.parse(text);
41+
```
42+
43+
<br>
44+
45+
```JavaScript
46+
const text = Graph.stringify(graph);
47+
48+
await Deno.writeTextFile('Example.graph',text);
49+
```
50+
51+
<br>
52+
53+
54+
<!----------------------------------------------------------------------------->
55+
56+
[Documentation]: https://github.com/OmegaTools/GRAPH/tree/main/Documentation
57+
[Examples]: https://github.com/OmegaTools/GRAPH/tree/main/Examples
58+
[License]: https://github.com/OmegaTools/GRAPH/blob/main/LICENSE
59+
[GitHub]: https://github.com/OmegaTools/GRAPH
60+
61+
62+
<!---------------------------------[ Badges ]---------------------------------->
63+
64+
[Badge License]: https://img.shields.io/badge/License-AGPL3-015d93.svg?style=for-the-badge&labelColor=blue
65+
[Badge Stars]: https://img.shields.io/github/stars/OmegaTools/GRAPH?style=for-the-badge&logoColor=white&logo=Trustpilot&labelColor=FF66AA&color=cf538b
66+
[Badge Commit]: https://img.shields.io/github/last-commit/OmegaTools/GRAPH?style=for-the-badge&logoColor=white&logo=Git&labelColor=64bc4b&color=539a3e
67+
68+
69+
<!---------------------------------[ Buttons ]--------------------------------->
70+
71+
[Button Documentation]: https://img.shields.io/badge/Documentation-blue?style=for-the-badge&logoColor=white&logo=BookStack
72+
[Button Examples]: https://img.shields.io/badge/Examples-64BC4B?style=for-the-badge&logoColor=white&logo=GitBook

0 commit comments

Comments
 (0)