Skip to content

Commit d32ae62

Browse files
committed
Now I finished the README
1 parent 33b4b1b commit d32ae62

File tree

1 file changed

+38
-0
lines changed

1 file changed

+38
-0
lines changed

README.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,36 @@
1010

1111
Isomorphic library to handle passing high-level data structures between AssemblyScript and JavaScript. 🤝🚀
1212

13+
[Markdown Parser Demo](https://torch2424.github.io/as-bind/)
14+
1315
![Asbind Markdown Parser Demo Gif](./assets/asbind.gif)
1416

17+
## Table of Contents
18+
19+
- [Features](#features)
20+
- [Installation](#installation)
21+
- [Quick Start](#quick-start)
22+
- [Motivation](#motivation)
23+
- [Supported Data Types](#supported-data-types)
24+
- [Supported AssemblyScript Runtime Variants](#supported-assemblyscript-runtime-variants)
25+
- [Performance](#performance)
26+
- [Reference API](#reference-api)
27+
- [AsBind](#asbind)
28+
- [Class Properties](#class-properties)
29+
- [version](#version)
30+
- [instantiate](#instantiate)
31+
- [Instance Properties](#instance-properties)
32+
- [exports](#exports)
33+
- [unboundExports](#unboundexports)
34+
- [importObject](#importobject)
35+
- [enableExportFunctionTypeCaching](#enableexportfunctiontypecaching)
36+
- [disableExportFunctionTypeCaching](#disableexportfunctiontypecaching)
37+
- [enableImportFunctionTypeCaching](#enableimportfunctiontypecaching)
38+
- [disableExportFunctionTypeCaching](#disableexportfunctiontypecaching-1)
39+
- [Projects using as-bind](#projects-using-as-bind)
40+
- [Contributing](#contributing)
41+
- [License](#license)
42+
1543
## Features
1644

1745
- The library is Isomorphic. Meaning it supports both the Browser, and Node! And has ESM, CommonJS, and IIFE bundles! 🌐
@@ -204,6 +232,16 @@ This will (re-)enable type caching (speculative execution) for ALL importObject
204232

205233
This will disable type caching (speculative execution) for ALL importObject functions on the AsBindInstance.
206234

235+
## Projects using as-bind
236+
237+
- The as-bind example is a Markdown Parser, in which as-bind takes in a string, passes it to a rough markdown parser / compiler written in AssemblyScript, and returns a string. [(Live Demo)](https://torch2424.github.io/as-bind/), [(Source Code)](https://github.com/torch2424/as-bind/tree/master/examples/markdown-parser)
238+
239+
## Contributing
240+
241+
Contributions are definitely welcome! Feel free to open a PR for small fixes such as typos and things. Larger fixes, or new features should start out as an issue for discussion, in which then a PR should be made.
242+
243+
This project will also adhere to the [AssemblyScript Code of Conduct](https://github.com/AssemblyScript/assemblyscript/blob/master/CODE_OF_CONDUCT.md).
244+
207245
## License
208246

209247
[MIT](https://oss.ninja/mit/torch2424).

0 commit comments

Comments
 (0)