Skip to content

Commit

Permalink
Updates to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
rowanc1 committed May 20, 2019
1 parent b749e4b commit 942e372
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 20 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,14 +31,14 @@ To get an idea of what that looks like, let's take the canonical example of *Tan

## Getting Started

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

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

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:
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):

```bash
>> npm install ink-components
Expand Down
12 changes: 8 additions & 4 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,17 +1,21 @@
{
"name": "ink-components",
"version": "0.1.6",
"version": "0.1.7",
"description": "Scientific web components for interactive scientific writing, reactive documents and explorable explanations.",
"main": "dist/ink.min.js",
"main": "dist/ink.js",
"unpkg": "dist/ink.min.js",
"module": "src/index.js",
"keywords": [],
"keywords": [
"explorable explanations",
"web components",
"writing"
],
"author": "rowanc1",
"license": "MIT",
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1",
"start": "webpack-dev-server --open --config webpack.dev.js",
"build-dev": "webpack --config webpack.dev.js",
"build-dev": "webpack --config webpack.dev.js && cp dist/ink.min.js dist/ink.js",
"build": "webpack --config webpack.prod.js"
},
"repository": {
Expand Down
19 changes: 5 additions & 14 deletions webpack.common.js
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,11 @@ module.exports = {
app: './src/index.js',
},
plugins: [
new CleanWebpackPlugin(['dist']),
// new CleanWebpackPlugin(['dist']),
new HtmlWebpackPlugin({
title: 'Main page',
title: 'Ink Components',
template: 'index.html'
}),
// new webpack.HotModuleReplacementPlugin()
})
],
output: {
filename: 'ink.min.js',
Expand All @@ -36,15 +35,7 @@ module.exports = {
use: [
'file-loader'
]
},
// {
// test: /\.tsx?$/,
// use: 'ts-loader',
// exclude: /node_modules/
// }
}
]
},
// resolve: {
// extensions: [ '.tsx', '.ts', '.js' ]
// },
}
};

0 comments on commit 942e372

Please sign in to comment.