diff --git a/README.md b/README.md index 9d3f556..7d907c8 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,58 @@ -[![Dependency Status](https://gemnasium.com/gmetais/YellowLabTools.svg)](https://gemnasium.com/gmetais/YellowLabTools) [![Build Status](https://travis-ci.org/gmetais/YellowLabTools.svg?branch=master)](https://travis-ci.org/gmetais/YellowLabTools) + -# Yellow Lab Tools - -Online tool that lets you test a webpage and detects **performance** and **front-end code quality** issues. +Useful tool that analyzes a webpage and detects **performance** and **front-end code quality** issues. -### Access the tool here: [http://yellowlab.tools](http://yellowlab.tools) +### Choose your way to use the tool: + + + + + + + + + + + + + + + + + + + + + + +
+The online tool (recommended) +[http://yellowlab.tools](http://yellowlab.tools) + + +
+The CLI (Command Line Interface) - [doc here](https://github.com/gmetais/YellowLabTools/wiki/Command-Line-Interface) +```npm install yellowlabtools -g``` + + +
+The Grunt task for developers or Continuous integration +Visit [gmetais/grunt-yellowlabtools](https://github.com/gmetais/grunt-yellowlabtools) + + +
+The NPM package - [doc here](https://github.com/gmetais/YellowLabTools/wiki/NodeJS-module) +```npm install yellowlabtools``` + + +
+The public API - [doc here](https://github.com/gmetais/YellowLabTools/wiki/Public-API) +Allows you to launch runs in a RESTful way + +

REST

+
-![example dashboard screenshot](screenshot.png) ## How it works @@ -16,24 +61,7 @@ The tool loads the given URL via [PhantomJS](http://phantomjs.org/) (a headless By the way, it's free because we are geeks, not businessmen. All we want is a ★ on GitHub, it will boost our motivation to add more awesome features!!! - -## Different ways to use YLT - -#### The online tool: -This is **the best way** to discover the tool: [http://yellowlab.tools](http://yellowlab.tools). -Please note the server is hosted in Baltimore, USA. - -#### The Command Line Interface (CLI): -Might be useful if you want to build an automation tool. The documentation is [here](https://github.com/gmetais/YellowLabTools/wiki/Command-Line-Interface). - -#### The NPM module: -Can be used to build automation tools in NodeJS. The documentation is [here](https://github.com/gmetais/YellowLabTools/wiki/NodeJS-module). - -#### The public API: -Hosted on our http://yellowlab.tools server, it is a RESTful API that allows you to launch distant tests. The documentation is [here](https://github.com/gmetais/YellowLabTools/wiki/Public-API). - -#### The Grunt task: -If you have a Continuous Integration platform, may I suggest you to use [grunt-yellowlabtools](https://github.com/gmetais/grunt-yellowlabtools)? You set it up once, then the task fails if the front-end quality conditions you defined are not met. +![example dashboard screenshot](./doc/img/screenshot.png) ## Test your localhost diff --git a/doc/img/YLT-animated.gif b/doc/img/YLT-animated.gif new file mode 100644 index 0000000..718d072 Binary files /dev/null and b/doc/img/YLT-animated.gif differ diff --git a/doc/img/YLT-cli-animated.gif b/doc/img/YLT-cli-animated.gif new file mode 100644 index 0000000..cc27d5d Binary files /dev/null and b/doc/img/YLT-cli-animated.gif differ diff --git a/doc/img/grunt-logo.png b/doc/img/grunt-logo.png new file mode 100644 index 0000000..8b1b5c0 Binary files /dev/null and b/doc/img/grunt-logo.png differ diff --git a/doc/img/logo.png b/doc/img/logo.png new file mode 100644 index 0000000..f8ecb4f Binary files /dev/null and b/doc/img/logo.png differ diff --git a/doc/img/npm-logo.png b/doc/img/npm-logo.png new file mode 100644 index 0000000..6251ff5 Binary files /dev/null and b/doc/img/npm-logo.png differ diff --git a/screenshot.png b/doc/img/screenshot.png similarity index 100% rename from screenshot.png rename to doc/img/screenshot.png