Skip to content

Commit a18ca07

Browse files
authored
Mention that this is not a general purpose library
1 parent dd1c1e6 commit a18ca07

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

README.adoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,14 @@
11
= Opal Runtime for Asciidoctor.js
2+
:caution-caption: :fire:
23

34
ifdef::env-github[]
45
image:https://img.shields.io/travis/Mogztter/asciidoctor-opal-node-runtime/master.svg[Travis build status, link=https://travis-ci.org/Mogztter/asciidoctor-opal-node-runtime]
56
image:http://img.shields.io/npm/v/asciidoctor-opal-runtime.svg[npm version, link=https://www.npmjs.org/package/asciidoctor-opal-runtime]
67
endif::[]
78

9+
[caption=Status]
10+
CAUTION: This library is an _highly optimized_ version of the Opal runtime that contains the *bare minimum to run Asciidoctor*. If you are looking for a general purpose Opal runtime, please use https://www.npmjs.com/package/opal-runtime.
11+
812
== Usage
913

1014
```javascript

0 commit comments

Comments
 (0)