From c140fea9e92f58153252179b14e35ae20d31d418 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ga=C3=ABl=20M=C3=A9tais?= Date: Thu, 14 Aug 2014 18:11:10 +0200 Subject: [PATCH] License and author --- README.md | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 436f0fa..72fdf93 100644 --- a/README.md +++ b/README.md @@ -9,14 +9,14 @@ Online tool designed to help Front-End developers optimize their website The tool is based on the fabulous [Phantomas](https://github.com/macbre/phantomas) by Maciej Brencz, that loads a page and collects many web performance metrics. I rewrote some modules to deeper analyse Javascript interactions with the DOM (especially with jQuery). -And then it is wrapped inside a small server (inspired by my favorite tool: [WebPageTest](http://www.webpagetest.org/)). +And then it is wrapped inside a small NodeJS server to get an interface (inspired by my favorite tool: [WebPageTest](http://www.webpagetest.org/)). **There are so many things left to do, your help would be greatly appreciated! Please report bugs, ask for evolutions and come code with me.** ## Install your own instance -### Manual installation +### Method 1: Manual installation You need this 3 brothers: [Git](http://git-scm.com/downloads), [NodeJS](http://nodejs.org/download/) and [Bower](http://bower.io/#install-bower). Click on the links to know how to install them. @@ -40,7 +40,7 @@ node server.js 4) Open you browser to [http://localhost:8383](http://localhost:8383). The default port 8383 can be changed in `server_config/settings.json`. -### In a virtual machine with Vagrant +### Method 2: In a virtual machine with Vagrant You need VirtualBox & Vagrant. @@ -55,4 +55,12 @@ cd YellowLabTools vagrant up ``` -3) Open your browser to [http://10.10.10.10](http://10.10.10.10). +3) Open your browser to [http://10.10.10.10](http://10.10.10.10) and have fun. + + +## License +Please read the [license](LICENSE). + + +## Author +Gaël Métais. I'm a webperf freelance based in Paris. If you understand french, you can visit [my website](http://www.gaelmetais.com). \ No newline at end of file