From 6f4fd7895b7d3376dc97670336ad3d5e7636ebef Mon Sep 17 00:00:00 2001 From: jloh Date: Sat, 6 Apr 2019 15:51:08 +1100 Subject: [PATCH] Start README --- README.md | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 00000000..145bcce8 --- /dev/null +++ b/README.md @@ -0,0 +1,33 @@ +# bulma-prefers-dark + +A Bulma extension that adds support for the `prefers-color-scheme` media query + +[![npm](https://img.shields.io/npm/v/bulma-prefers-dark.svg)](https://www.npmjs.com/package/bulma-divider) +[![npm](https://img.shields.io/npm/dm/bulma-prefers-dark.svg)](https://www.npmjs.com/package/bulma-divider) + +## Installation + +``` +npm install --save bulma-prefers-dark +... Or ... +yarn add bulma-prefers-dark +``` + + + +## Usage + +This extension works as-is in combination with Bulma by adding an alternative dark theme via the [`@media (prefers-color-scheme: dark)` scheme](https://caniuse.com/#search=prefers-color-scheme). + +Include it in your SaSS pipeline and you're good to go: + +```sass +@import "../../node_modules/bulma/bulma.sass"; +@import "../../bulma-prefers-dark/bulma-prefers-dark.sass"; +``` + + + +## Copyright & License + +Code copyright 2019 James Loh. Code released under the [MIT license](LICENSE).