@carbon/colors - npm Package Compare versions

Comparing version 0.0.1-alpha.24 to 0.0.1-alpha.25

es/index.js

@@ -0,1 +1,7 @@
+/**
+ * Copyright IBM Corp. 2018, 2018
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
 var colors = {
@@ -2,0 +8,0 @@ black: '#000000',

lib/index.js

@@ -5,2 +5,8 @@ 'use strict';
 
+/**
+ * Copyright IBM Corp. 2018, 2018
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
 var colors = {
@@ -7,0 +13,0 @@ black: '#000000',

package.json

 {
   "name": "@carbon/colors",
-  "version": "0.0.1-alpha.24",
+  "description": "Colors for digital and software products using the Carbon Design System",
+  "version": "0.0.1-alpha.25",
   "license": "Apache-2.0",
@@ -31,4 +32,4 @@ "main": "lib/index.js",
   "devDependencies": {
-    "@carbon/bundler": "0.0.1-alpha.24",
-    "@carbon/cli-reporter": "0.0.1-alpha.24",
+    "@carbon/bundler": "0.0.1-alpha.25",
+    "@carbon/cli-reporter": "0.0.1-alpha.25",
     "fs-extra": "^7.0.0",
@@ -35,0 +36,0 @@ "node-sass": "^4.9.4",

README.md

@@ -1,8 +0,10 @@
-# `@carbon/colors`
+# @carbon/colors
 
-> Colors for digital and software products using the Carbon Design System.
+> Colors for digital and software products using the Carbon Design
+> System
 
-## Getting Started
+## Getting started
 
-Run the following command using [npm](https://www.npmjs.com/):
+To install `@carbon/colors` in your project, you will need to run the
+following command using [npm](https://www.npmjs.com/):
 
@@ -13,4 +15,4 @@ ```bash
 
-If you prefer [Yarn](https://yarnpkg.com/en/), use the following command
-instead:
+If you prefer [Yarn](https://yarnpkg.com/en/), use the following
+command instead:
 
@@ -23,4 +25,4 @@ ```bash
 
-You can use the `@carbon/colors` module in your JavaScript, in addition to
-your Sass.
+You can use the `@carbon/colors` module in your JavaScript, in
+addition to your Sass.
 
@@ -40,4 +42,4 @@ ### JavaScript
 
-Each color swatch is exported on the `colors` object and can be called by
-specifying the name and grade, for example:
+Each color swatch is exported on the `colors` object and can be called
+by specifying the name and grade, for example:
 
@@ -66,5 +68,4 @@ ```js
 
-This will make all the colors and token variables available to you in your file.
-They are named with the following structure: `$ibm-color__swatch--grade`, for
-example:
+This will make all the colors and token variables available to you in
+your file. They are named with the following structure: `$ibm-color__swatch--grade`, for example:
 
@@ -78,4 +79,18 @@ ```scss
 
-## 🤲 Contributing
+## 📚 Examples
 
-To learn more about how to contribute, look [here](/.github/CONTRIBUTING.md)!
+If you're looking for more examples on how to use `@carbon/colors`, we
+have some examples that you can check out:
+
+- [Basic](./examples/basic)
+
+## 🙌 Contributing
+
+We're always looking for contributors to help us fix bugs, build new
+features, or help us improve the project documentation. If you're
+interested, definitely check out our [Contributing Guide](/.github/CONTRIBUTING.md)
+! 👀
+
+## 📝 License
+
+Licensed under the [Apache 2.0 License](/LICENSE).

umd/index.js

@@ -7,2 +7,8 @@ (function (global, factory) {
 
+  /**
+   * Copyright IBM Corp. 2018, 2018
+   *
+   * This source code is licensed under the Apache-2.0 license found in the
+   * LICENSE file in the root directory of this source tree.
+   */
   var colors = {
@@ -9,0 +15,0 @@ black: '#000000',

No alert changes

Improved metrics

Total package byte prevSize

19962

increased by5.71%

Lines of code

479

increased by3.9%

Number of lines in readme file

92

increased by19.48%

No dependency changes