irc-colors - npm Package Compare versions

Comparing version 1.0.0 to 1.0.1

package.json

@@ -5,4 +5,3 @@ {
   "keywords": ["irc", "color", "colour"],
-  "version": "1.0.0",
-  "homepage": "https://github.com/fent/irc-colors.js",
+  "version": "1.0.1",
   "repository": {
@@ -12,6 +11,3 @@ "type": "git",
   },
-  "author": {
-    "name": "Roly Fentanes",
-    "url": "https://github.com/fent"
-  },
+  "author": "Roly Fentanes (https://github.com/fent)",
   "main": "./lib/irc-colors.js",
@@ -18,0 +14,0 @@ "directories": {

README.md

@@ -0,14 +1,22 @@
+Install
+------------
+
+    npm install irc-colors
+
+
 Usage
 ------------------
 
-    c = require('irc-colors');
-    ...
-    ircbot.say('#chan', c.blue('hello everyone')); // prints blue text
-    ircbot.say('#chan', c.underline.red('WARNING')); // can be chained
-    ircbot.say('#chan', c.white.bgblack('inverted')); // white text with black background
-    
-    warn = c.bold.red.bgyellow;
-    ircbot.say('#chan', warn('BIGGER WARNING')); // bold red text with yellow background
-    ircbot.say('#chan', c.rainbow('having fun!'); // prints rainbow colored text
+```javascript
+c = require('irc-colors');
+...
+ircbot.say('#chan', c.blue('hello everyone')); // prints blue text
+ircbot.say('#chan', c.underline.red('WARNING')); // can be chained
+ircbot.say('#chan', c.white.bgblack('inverted')); // white text with black background
 
+warn = c.bold.red.bgyellow;
+ircbot.say('#chan', warn('BIGGER WARNING')); // bold red text with yellow background
+ircbot.say('#chan', c.rainbow('having fun!'); // prints rainbow colored text
+```
+
 ### But wait, there's more!
@@ -18,7 +26,9 @@
 
-    require('irc-colors').global()
-    ...
-    ircbot.say('#chan', 'say something'.irc.red()); // prints red text
-    ircbot.say('#chan', 'hi everyone!'.irc.green.bold()); // prints green bold text
-    ircbot.say('#chan', 'etc etc'.irc.underline.grey.bgblack()) // chains work too
+```javascript
+require('irc-colors').global()
+...
+ircbot.say('#chan', 'say something'.irc.red()); // prints red text
+ircbot.say('#chan', 'hi everyone!'.irc.green.bold()); // prints green bold text
+ircbot.say('#chan', 'etc etc'.irc.underline.grey.bgblack()) // chains work too
+```
 
@@ -30,18 +40,3 @@ Global syntax was inspired by [colors.js](https://github.com/Marak/colors.js) and because of that, there's possibility that you might want to use that module along with this one. That's why the *irc* property of a String needs to be called first to use the formatting functions.
 --------------
-* <span style="color:white;background-color:black">**white**</span>
-* <span style="color:black">**black**</span>
-* <span style="color:navy">**navy**</span>
-* <span style="color:green">**green**</span>
-* <span style="color:red">**red**</span>
-* <span style="color:brown">**brown (maroon)**</span>
-* <span style="color:purple">**purple (violet)**</span>
-* <span style="color:olive">**olive**</span>
-* <span style="color:yellow">**yellow**</span>
-* <span style="color:lime">**light green (lime)**</span>
-* <span style="color:teal">**teal (blue cyan)**</span>
-* <span style="color:darkcyan">**cyan (aqua)**</span>
-* <span style="color:blue">**blue (royal)**</span>
-* <span style="color:fuchsia">**pink (light purple) (fuchsia)**</span>
-* <span style="color:gray">**gray (grey)**</span>
-* <span style="color:silver">**light gray (light grey) (silver)**</span>
+![colors](https://github.com/fent/irc-colors.js/raw/master/img/colors.png)
 
@@ -55,5 +50,3 @@ Original name or alternate can be used, without spaces
 ------------
-* **bold**
-* *italic*
-* <u>underline</u>
+![styles](https://github.com/fent/irc-colors.js/raw/master/img/styles.png)
 
@@ -63,10 +56,3 @@
 -----------
-* **<span style="color:red">r</span><span style="color:orange">a</span><span style="color:yellow">i</span><span style="color:green">n</span><span style="color:blue">b</span><span style="color:navy">o</span><span style="color:purple">w</span>**
+![extras](https://github.com/fent/irc-colors.js/raw/master/img/extras.png)
 
-
-Installation
-------------
-Using npm:
-
-    $ npm install irc-colors
-

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

No website

Quality

Package does not have a website.

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

22838

increased by68%

Number of package files

12

increased by9.09%

Worsened metrics

Lines of code

144

decreased by-29.41%

Number of low quality alerts

1

increased byInfinity%

Number of lines in readme file

55

decreased by-20.29%

No dependency changes