diff --git a/README.md b/README.md index 68e307e..6630e70 100644 --- a/README.md +++ b/README.md @@ -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 ``` -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 diff --git a/package.json b/package.json index c352b02..4dcfc3a 100644 --- a/package.json +++ b/package.json @@ -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": { diff --git a/webpack.common.js b/webpack.common.js index 31a6dc3..9bad810 100644 --- a/webpack.common.js +++ b/webpack.common.js @@ -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', @@ -36,15 +35,7 @@ module.exports = { use: [ 'file-loader' ] - }, - // { - // test: /\.tsx?$/, - // use: 'ts-loader', - // exclude: /node_modules/ - // } + } ] - }, - // resolve: { - // extensions: [ '.tsx', '.ts', '.js' ] - // }, + } };