Skip to content

Commit 443af22

Browse files
committed
Update readme
1 parent 6c4b4f3 commit 443af22

File tree

2 files changed

+64
-40
lines changed

2 files changed

+64
-40
lines changed

LICENSE

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
The MIT License (MIT)
2+
3+
Copyright (c) 2019 Rowan Cockett
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

+43-40
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
11
# Ink Components
22

3+
[![Ink Components on npm](https://img.shields.io/npm/v/ink-components.svg)](https://www.npmjs.com/package/ink-components)
4+
[![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/rowanc1/ink-components/blob/master/LICENSE)
5+
[![Published on webcomponents.org](https://img.shields.io/badge/webcomponents.org-published-blue.svg)](https://www.webcomponents.org/element/ink-components)
6+
7+
38
The goal of ink.js is to provide web-components for interactive scientific writing, reactive documents and explorable explanations.
49
Included in `ink.js` are ways to create, update and display variables as text, equations and charts.
510

@@ -24,46 +29,6 @@ To get an idea of what that looks like, let's take the canonical example of Tang
2429
</p>
2530
```
2631

27-
## Components
28-
29-
https://www.webcomponents.org/element/ink-components/elements/cv-award
30-
31-
* Variables, actions and displays
32-
* ink-scope
33-
* ink-var
34-
* ink-varList
35-
* ink-display
36-
* ink-range
37-
* ink-dynamic
38-
* ink-button
39-
* ink-action
40-
* Charts
41-
* ink-chart
42-
* ink-chartCircle
43-
* ink-chartPath
44-
* ink-chartText
45-
* ink-chartNode
46-
* ink-chartEqn
47-
* Simple layout
48-
* ink-article
49-
* ink-equation
50-
* ink-figure
51-
* ink-code
52-
* ink-outline
53-
* ink-aside
54-
* ink-callout
55-
* ink-quote
56-
* ink-card
57-
* ink-byline
58-
* h2-more
59-
* ink-span
60-
* ink-p
61-
* ink-div
62-
* Resume elements
63-
* cv-item
64-
* cv-award
65-
66-
6732
## Getting Started
6833

6934
Ink is based on web components, which create custom HTML tags so that they can make writing documents easier.
@@ -84,3 +49,41 @@ You should then be able to extend ink as you see fit:
8449
```javascript
8550
import * as ink from 'ink-components';
8651
```
52+
53+
## Components
54+
55+
* Variables, actions and displays
56+
* [ink-scope](https://www.webcomponents.org/element/ink-components/elements/ink-scope)
57+
* [ink-var](https://www.webcomponents.org/element/ink-components/elements/ink-var)
58+
* [ink-varList](https://www.webcomponents.org/element/ink-components/elements/ink-varList)
59+
* [ink-display](https://www.webcomponents.org/element/ink-components/elements/ink-display)
60+
* [ink-range](https://www.webcomponents.org/element/ink-components/elements/ink-range)
61+
* [ink-dynamic](https://www.webcomponents.org/element/ink-components/elements/ink-dynamic)
62+
* [ink-button](https://www.webcomponents.org/element/ink-components/elements/ink-button)
63+
* [ink-action](https://www.webcomponents.org/element/ink-components/elements/ink-action)
64+
* Charts
65+
* [ink-chart](https://www.webcomponents.org/element/ink-components/elements/ink-chart)
66+
* [ink-chart-circle](https://www.webcomponents.org/element/ink-components/elements/ink-chart-circle)
67+
* [ink-chart-path](https://www.webcomponents.org/element/ink-components/elements/ink-chart-path)
68+
* [ink-chart-text](https://www.webcomponents.org/element/ink-components/elements/ink-chart-text)
69+
* [ink-chart-node](https://www.webcomponents.org/element/ink-components/elements/ink-chart-node)
70+
* [ink-chart-eqn](https://www.webcomponents.org/element/ink-components/elements/ink-chart-eqn)
71+
* Simple layout
72+
* [ink-article](https://www.webcomponents.org/element/ink-components/elements/ink-article)
73+
* [ink-equation](https://www.webcomponents.org/element/ink-components/elements/ink-equation)
74+
* [ink-figure](https://www.webcomponents.org/element/ink-components/elements/ink-figure)
75+
* [ink-code](https://www.webcomponents.org/element/ink-components/elements/ink-code)
76+
* [ink-outline](https://www.webcomponents.org/element/ink-components/elements/ink-outline)
77+
* [ink-aside](https://www.webcomponents.org/element/ink-components/elements/ink-aside)
78+
* [ink-callout](https://www.webcomponents.org/element/ink-components/elements/ink-callout)
79+
* [ink-quote](https://www.webcomponents.org/element/ink-components/elements/ink-quote)
80+
* [ink-card](https://www.webcomponents.org/element/ink-components/elements/ink-card)
81+
* [ink-byline](https://www.webcomponents.org/element/ink-components/elements/ink-byline)
82+
* [h2-more](https://www.webcomponents.org/element/ink-components/elements/h2-more)
83+
* [ink-span](https://www.webcomponents.org/element/ink-components/elements/ink-span)
84+
* [ink-p](https://www.webcomponents.org/element/ink-components/elements/ink-p)
85+
* [ink-div](https://www.webcomponents.org/element/ink-components/elements/ink-div)
86+
* Resume elements
87+
* [cv-item](https://www.webcomponents.org/element/ink-components/elements/cv-item)
88+
* [cv-award](https://www.webcomponents.org/element/ink-components/elements/cv-award)
89+

0 commit comments

Comments
 (0)