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

updated README.md

Browse Source
This commit is contained in:
Clément GOUIN
2019-07-10 15:23:00 +02:00
parent 0586d412e4
commit 49e1ebf163
1 changed files with 47 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+47 -5
View File
@@ -1,10 +1,52 @@
[![npm version](https://img.shields.io/npm/v/fa-diagrams.svg)](https://www.npmjs.com/package/fa-diagrams)
[![Build Status](https://img.shields.io/travis/Klemek/fa-diagrams.svg?branch=master)](https://travis-ci.org/Klemek/fa-diagrams) [![Build Status](https://img.shields.io/travis/Klemek/fa-diagrams.svg?branch=master)](https://travis-ci.org/Klemek/fa-diagrams)
[![Coverage Status](https://img.shields.io/coveralls/github/Klemek/fa-diagrams.svg?branch=master)](https://coveralls.io/github/Klemek/fa-diagrams?branch=master) [![Coverage Status](https://img.shields.io/coveralls/github/Klemek/fa-diagrams.svg?branch=master)](https://coveralls.io/github/Klemek/fa-diagrams?branch=master)
# fa-diagrams # (WIP) fa-diagrams
## (WIP) SVG diagrams built from Font-Awesome icons ## SVG diagrams built from Font-Awesome icons
## Build from sources * [Install](#install)
* [CDN](#cdn)
* [Static script](#static-script)
* [NPM](#npm)
* [Build from sources](#build-from-sources)
* [Usage](#usage)
* [Node module](#node-module)
* [Html script](#script
## Install
### Static script
Get the scripts from this repository `dist` folder
```html
<script src="fa-diagrams-data.min.js"></script>
<script src="fa-diagrams.min.js"></script>
```
### 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>
```
### NPM (soon)
```
npm install fa-diagrams
```
### Build from sources
You will need subversion installed (used for precise folder fetching in GitHub) You will need subversion installed (used for precise folder fetching in GitHub)
@@ -17,7 +59,7 @@ node build.sh
## Usage ## Usage
### With node ### Node module
```javascript ```javascript
const diag = require('fa-diagrams'); const diag = require('fa-diagrams');
@@ -56,7 +98,7 @@ Will produce the following diagram :
![sample](sample.png) ![sample](sample.png)
### On web page ### Html script
```html ```html
<head> <head>