From 9fc96acdfe90d642b23f95393cf8058779200f66 Mon Sep 17 00:00:00 2001 From: Im-Beast Date: Sat, 8 May 2021 12:52:04 +0200 Subject: [PATCH] update README for deno lib --- deno_lib/README.md | 16 +++++++--------- 1 file changed, 7 insertions(+), 9 deletions(-) diff --git a/deno_lib/README.md b/deno_lib/README.md index e68c886..f62019d 100644 --- a/deno_lib/README.md +++ b/deno_lib/README.md @@ -1,14 +1,9 @@ -

🖍️ Crayon.js color support

+

🖍️ Crayon.js color support for 🦕 Deno


## :books: About ##### This package is extension for [crayon.js](https://github.com/crayon-js/crayon) however it can still be used by other packages. -### Installation -```bash -npm install @crayon.js/color-support #yarn add @crayon.js/color-support -``` - ## Syntax ```ts interface CrayonColorSupport { @@ -21,7 +16,7 @@ interface CrayonColorSupport { ## Usage ```ts -import { getColorSupport, supportedColors, getWindowsVersion } from '@crayon.js/color-support'; +import { getColorSupport, supportedColors, getWindowsVersion } from 'https://deno.land/x/crayon-color-support/mod.ts'; const support = getColorSupport(); // detect terminal color support const cached = supportedColors(); // cached getColorSupport (it just returns cached object) @@ -30,12 +25,15 @@ const windowsVersion = getWindowsVersion(); // Reusable function [version (7/8/1 ## Usage with crayon.js ```ts -import crayon from 'crayon.js'; // it'll still work with packages that extend crayon instance as its config is global -import { getColorSupport } from '@crayon.js/color-support'; +import crayon from 'https://deno.land/x/crayon/mod.ts'; // it'll still work with modules that extend crayon instance as its config is global +import { getColorSupport } from 'https://deno.land/x/crayon-color-support/mod.ts'; crayon.config.colorSupport = getColorSupport(); ``` +### Wiki +To learn more about Crayon and its API look [here](https://github.com/crayon-js/crayon/wiki) + ## :handshake: Contributing #### Feel free to add any commits, issues and pull requests