Skip to content

Commit 942e372

Browse files
committed
Updates to readme
1 parent b749e4b commit 942e372

File tree

3 files changed

+15
-20
lines changed

3 files changed

+15
-20
lines changed

README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -31,14 +31,14 @@ To get an idea of what that looks like, let's take the canonical example of *Tan
3131

3232
## Getting Started
3333

34-
Ink is based on web components, which create custom HTML tags so that they can make writing documents easier.
34+
Ink is based on web-components, which creates custom HTML tags so that they can make writing documents easier.
3535
To get started, copy the built javascript file to the head of your page:
3636

3737
```html
3838
<script src="https://unpkg.com/ink-components"></script>
3939
```
4040

41-
You can also download the latest release from GitHub. If you are running this without a web server, ensure the script has `charset="utf-8"` in the script tag. You can also install from npm:
41+
You can also download the [latest release](https://github.com/ink-components/ink-components/releases) from GitHub. If you are running this without a web server, ensure the script has `charset="utf-8"` in the script tag. You can also [install from npm](https://www.npmjs.com/package/ink-components):
4242

4343
```bash
4444
>> npm install ink-components

package.json

+8-4
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,21 @@
11
{
22
"name": "ink-components",
3-
"version": "0.1.6",
3+
"version": "0.1.7",
44
"description": "Scientific web components for interactive scientific writing, reactive documents and explorable explanations.",
5-
"main": "dist/ink.min.js",
5+
"main": "dist/ink.js",
66
"unpkg": "dist/ink.min.js",
77
"module": "src/index.js",
8-
"keywords": [],
8+
"keywords": [
9+
"explorable explanations",
10+
"web components",
11+
"writing"
12+
],
913
"author": "rowanc1",
1014
"license": "MIT",
1115
"scripts": {
1216
"test": "echo \"Error: no test specified\" && exit 1",
1317
"start": "webpack-dev-server --open --config webpack.dev.js",
14-
"build-dev": "webpack --config webpack.dev.js",
18+
"build-dev": "webpack --config webpack.dev.js && cp dist/ink.min.js dist/ink.js",
1519
"build": "webpack --config webpack.prod.js"
1620
},
1721
"repository": {

webpack.common.js

+5-14
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,11 @@ module.exports = {
1111
app: './src/index.js',
1212
},
1313
plugins: [
14-
new CleanWebpackPlugin(['dist']),
14+
// new CleanWebpackPlugin(['dist']),
1515
new HtmlWebpackPlugin({
16-
title: 'Main page',
16+
title: 'Ink Components',
1717
template: 'index.html'
18-
}),
19-
// new webpack.HotModuleReplacementPlugin()
18+
})
2019
],
2120
output: {
2221
filename: 'ink.min.js',
@@ -36,15 +35,7 @@ module.exports = {
3635
use: [
3736
'file-loader'
3837
]
39-
},
40-
// {
41-
// test: /\.tsx?$/,
42-
// use: 'ts-loader',
43-
// exclude: /node_modules/
44-
// }
38+
}
4539
]
46-
},
47-
// resolve: {
48-
// extensions: [ '.tsx', '.ts', '.js' ]
49-
// },
40+
}
5041
};

0 commit comments

Comments
 (0)