Merge pull request #172 from dhershman1/to-module

Kyanite 2.0.0 Module Upgrade

.gitignore

@@ -4,6 +4,7 @@ exp.js
 test.html
 dist/
 TODO.md
+docs/
 
 # Created by https://www.toptal.com/developers/gitignore/api/macos,node
 # Edit at https://www.toptal.com/developers/gitignore?templates=macos,node

CHANGELOG.md

@@ -1,5 +1,26 @@
 # Changelog
 
+## v2.0.0
+
+### Breaking Changes
+
+- Converted kyanite to a full blown javascript module
+  - This may cause support issues for IE 11
+- Converted from UMD to CJS support
+  - This may cause support issues for IE 11
+- The minified scripts now use `K` instead of `kyanite` as the TS files specificy
+- Removed unminified version of the library in favor of breaking down supporting of multiple formats
+- Removed "local copy" future support for direct html script tags
+
+### Chore
+
+- Export script completely re written
+- Updated all dev dependencies
+
+### Fixed
+
+- Rollup build stuff to be easier to use on my end and offer more stable support when I run builds
+
 ## v1.6.3
 
 ### Changed

README.md

@@ -58,16 +58,16 @@ The goal for Kyanite is to be stripped down, light weight, and intuitive. The id
 
 ## How To
 
+> **Note:** As of `v2.0.0` the module should be imported as just `K` instead of `kyanite`
+> The unminified version of the library is no longer available as of 2.0.0
+
 With a CDN
 
 ```html
 <!-- It is recommended to replace the @latest with a strict version number for production -->
-<script src="https://cdn.jsdelivr.net/npm/kyanite@latest/dist/kyanite.min.js"></script>
-<!-- To use the debug friendly kyanite simply remove .min from the filename -->
-<script src="https://cdn.jsdelivr.net/npm/kyanite@latest/dist/kyanite.js"></script>
-<script>
-  const K = kyanite
+<script src="https://cdn.jsdelivr.net/npm/kyanite@latest/dist/kyanite.iife.min.js"></script>
 
+<script>
   K.isEmpty({})
 </script>
 ```
@@ -79,31 +79,13 @@ Standard module system
 ```js
 // This will use the module path in the package.json (src/index.js)
 import * as K from 'kyanite'
-// However if you want to grab the dev version
-import * as K from 'kyanite/dist/kyanite.js'
 ```
 
 Common JS
 
 ```js
 // For the prod minified version
 const K = require('kyanite')
-// For the dev/debug friendly version
-const K = require('kyanite/dist/kyanite.js')
-```
-
-Local copy script tag
-
-```html
-<!-- To use the prod minified version -->
-<script src="/path/to/dist/kyanite.min.js"></script>
-<!-- To use the dev/debug friendly version -->
-<script src="/path/to/dist/kyanite.js"></script>
-<script>
-  const K = kyanite
-
-  K.isEmpty({})
-</script>
 ```
 
 ## Testing