@assortment/darkmodejs - npm Package Compare versions

Comparing version 0.0.1 to 0.0.2

package.json

 {
   "name": "@assortment/darkmodejs",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "Utility package for managing Dark Mode on the web",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

@@ -6,5 +6,4 @@ # darkmodejs
 [![Status](https://img.shields.io/badge/status-active-success.svg)]()
-[![GitHub Issues](https://img.shields.io/github/issues/assortment/darkmodejs.svg)](https://github.com/assortment/darkmodejs/issues)
-[![GitHub Pull Requests](https://img.shields.io/github/issues-pr/assortment/darkmodejs.svg)](https://github.com/assortment/darkmodejs/pulls)
 [![License](https://img.shields.io/badge/license-MIT-blue.svg)](/LICENSE)
+[![npm](https://img.shields.io/npm/v/@assortment/darkmodejs.svg)](https://www.npmjs.com/package/@assortment/darkmodejs)
 
@@ -21,2 +20,5 @@ </div>
 
+![Example application using darkmodejs in Windows 10 Firefox](https://i.imgur.com/ZR2aGIE.gif)
+_Example application using darkmodejs in Windows 10 Firefox_
+
 ## 📝 Prerequisites
@@ -117,4 +119,27 @@
 
+## 🎬 Examples
+
+The following examples are taken from `darkmodejs-demo`, a demo application created to show how you can use `@assortment/darkmodejs` in conjunction with [Emotion Theming](https://emotion.sh/docs/theming) to control your website's theme based on a user's OS preference.
+
+- 💻 Code: https://github.com/Assortment/darkmodejs-demo
+- 🌐 URL: https://darkmodejs-demo.netlify.com/
+
+### Windows 10:
+
+#### Firefox (supported)
+
+![Supported in Windows 10 with Firefox](https://i.imgur.com/ZR2aGIE.gif)
+
+#### Chrome (not supported until Chrome 76)
+
+![Not supported in Windows 10 with Chrome 75](https://i.imgur.com/C6pyZVr.gif)
+
+### No preference
+
+Special mention to `no-preference`. To my knowledge I don't believe any Operating System currently allows for a no preference option, so there's no current circumstance where this returns true from a `prefers-color-scheme` media query. That said, [as its part of the specification](https://developer.mozilla.org/en-US/docs/Web/CSS/@media/prefers-color-scheme) I've included it as an option in the demo app if you ever want to do anything specific.
+
+![Example no preference theme set](https://i.gyazo.com/5555e2439eadfcf80e184b7a4434fbc5.png)
+
 ## ✍️ License
 
 MIT © [Luke Whitehouse](https://lukewhitehouse.co.uk)

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

210324

increased by0.58%

Number of lines in readme file

143

increased by21.19%

No dependency changes