klemek/fa-diagrams
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[skip CI] updated README.md

Browse Source
This commit is contained in:
Klemek
2019-07-18 09:16:26 +02:00
parent 15779410fe
commit e6a2d21268
1 changed files with 54 additions and 54 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+54 -54
View File
@@ -25,14 +25,14 @@
## Summary
* [Usage](#usage)
* [Node module](#node-module)
* [Html script](#html-script)
* [Install](#install)
* [CDN](#cdn)
* [Static scripts](#static-scripts)
* [NPM](#npm)
* [Build from sources](#build-from-sources)
* [Usage](#usage)
* [Node module](#node-module)
* [Html script](#html-script)
* [API](#api)
* [`options`](#options)
* [`nodes`](#nodes)
@@ -44,57 +44,6 @@
* [Thrown errors](#thrown-errors)
* [Change icons](#change-icons)
* [Examples](#examples)
## Install
*[back to top](#top)*
### Static scripts
Get the scripts from this repository `dist` folder
```html
<script src="fa-diagrams-data.min.js"></script> <!-- 1.04 MB -->
<script src="fa-diagrams.min.js"></script> <!-- 110.40 KB -->
```
### CDN (soon)
```html
<script src="https://cdn.jsdelivr.net/npm/fa-diagrams@latest/dist/fa-diagrams-data.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/fa-diagrams@latest/dist/fa-diagrams.min.js"></script>
```
or
```html
<script src="https://unpkg.com/fa-diagrams/dist/fa-diagrams-data.min.js"></script>
<script src="https://unpkg.com/fa-diagrams/dist/fa-diagrams.min.js"></script>
```
or
```html
<script src="https://cdn.rawgit.com/Klemek/fa-diagrams/master/dist/fa-diagrams-data.min.js"></script>
<script src="https://cdn.rawgit.com/Klemek/fa-diagrams/master/dist/fa-diagrams.min.js"></script>
```
### NPM (soon)
```
npm install fa-diagrams
```
### Build from sources
You will need subversion installed (used for precise folder fetching in GitHub)
```
git clone https://github.com/klemek/fa-diagrams.git
cd fa-diagrams
npm install
node build.sh
```
## Usage
*[back to top](#top)*
@@ -168,6 +117,57 @@ Will produce the following diagram:
</html>
```
## Install
*[back to top](#top)*
### Static scripts
Get the scripts from this repository `dist` folder
```html
<script src="fa-diagrams-data.min.js"></script> <!-- 1.04 MB -->
<script src="fa-diagrams.min.js"></script> <!-- 110.40 KB -->
```
### CDN (soon)
```html
<script src="https://cdn.jsdelivr.net/npm/fa-diagrams@latest/dist/fa-diagrams-data.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/fa-diagrams@latest/dist/fa-diagrams.min.js"></script>
```
or
```html
<script src="https://unpkg.com/fa-diagrams/dist/fa-diagrams-data.min.js"></script>
<script src="https://unpkg.com/fa-diagrams/dist/fa-diagrams.min.js"></script>
```
or
```html
<script src="https://cdn.rawgit.com/Klemek/fa-diagrams/master/dist/fa-diagrams-data.min.js"></script>
<script src="https://cdn.rawgit.com/Klemek/fa-diagrams/master/dist/fa-diagrams.min.js"></script>
```
### NPM (soon)
```
npm install fa-diagrams
```
### Build from sources
You will need subversion installed (used for precise folder fetching in GitHub)
```
git clone https://github.com/klemek/fa-diagrams.git
cd fa-diagrams
npm install
node build.sh
```
## API
*[back to top](#top)*