@dialpad/dialtone - npm Package Compare versions

Comparing version 3.1.0 to 3.2.0

package.json

 {
   "name": "@dialpad/dialtone",
   "description": "The design system for Dialpad and UberConference",
-  "version": "3.1.0",
+  "version": "3.2.0",
   "author": "Joshua Hynes",
@@ -6,0 +6,0 @@ "files": [

README.md

@@ -7,4 +7,61 @@ # Dialpad Design
 
-## Have a question?
+## Building Dialtone locally
 
-If you have a question, please feel free to [open an issue](https://github.com/dialpad/design/issues/new).
+Here's how to build Dialtone locally:
+
+### Install Ruby via Homebrew:
+
+In order to run Jekyll, you will need a full Ruby development environment. If you don't have this, install Ruby using Homebrew with the steps below. If you already have a Ruby environment installed, move on to the next step.
+
+```
+brew install ruby
+brew install brew-gem
+brew gem install bundler
+```
+
+### Clone the repo
+
+First download the repo to your machine:
+
+```
+// SSH
+git clone [e-mail]:dialpad/dialtone.git
+
+// HTTPS
+git clone https://github.com/dialpad/dialtone.git
+```
+
+Then `cd` into the Dialtone directory:
+```
+cd /dialtone
+```
+
+### Install Gulp
+
+This assumes Node and NPM are already installed. If you don't have these installed, *please install those first.* If you do have Node and NPM installed, proceed with installing gulp:
+
+```
+npm install gulp
+```
+
+### Install Bundler & Jekyll
+
+Dialtone currently uses Jekyll, a static HTML generator, to build its documentation. Use Bundler to install Jekyll and its dependencies.
+
+- Switch to the `docs` folder in the Dialtone directory. `cd docs`
+- Install Bundler and Jekyll: `gem install jekyll bundler`
+- Install the Bundle: `bundle install`
+
+### Building Dialtone
+
+Once everything is installed, navigate back out of the `docs` folder (`cd ../`) and start your server by typing the following command:
+
+```
+gulp
+```
+
+Dialtone should now be available at `http://localhost:4000`
+
+## Questions?
+
+If you have a question, please feel free to [open an issue](https://github.com/dialpad/dialtone/issues/new).

New alerts

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

Improved metrics

Number of lines in readme file

67

increased by570%

Worsened metrics

Total package byte prevSize

293304

decreased by-1.66%

Lines of code

4396

decreased by-0.48%

Number of medium supply chain risk alerts

1

increased byInfinity%

No dependency changes