Browse Source

Add a screenshot to README

Gaël Métais 10 năm trước cách đây
mục cha
commit
a15e04c7d0
2 tập tin đã thay đổi với 10 bổ sung9 xóa
  1. 10 9
      README.md
  2. BIN
      screenshot.png

+ 10 - 9
README.md

@@ -7,27 +7,29 @@ Online tool that lets you test a webpage and detects **performance** and **front
 
 ### Access the tool here: [http://yellowlab.tools](http://yellowlab.tools)
 
+![example dashboard screenshot](screenshot.png)
+
 
 ## How it works
 
 The tool loads the given URL via [PhantomasJS](http://phantomjs.org/) (a headless browser) and collects various metrics and statistics with the help of [Phantomas](https://github.com/macbre/phantomas). These metrics are categorized and transformed into scores. It also gives in-depth details so developpers can correct the detected issues.
 
-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!!!
+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
 
-#### Web interface
+#### The web interface:
 This is the best way to discover the tool: [http://yellowlab.tools](http://yellowlab.tools).  
 Please note the server is hosted in Baltimore, USA.
 
-#### Command Line
+#### The Command Line Client:
 Might be useful if you want to build an automation tool. The documentation is [here](https://github.com/gmetais/YellowLabTools/wiki/Command-Line-Interface).
 
-#### NodeJS module
+#### The NPM module:
 Can be used to build automation tools in NodeJS. The documentation is [here](https://github.com/gmetais/YellowLabTools/wiki/NodeJS-module).
 
-#### Public API
+#### 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).
 
 
@@ -38,12 +40,11 @@ If your project is not accessible from outside, or if you want to fork and impro
 
 ## Help needed
 
-**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.**
+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.
 
 
 ## License
-Please read the [license](LICENSE).
-
+Please read the [license](LICENSE).  
 Icons are the property of [IcoMoon.io](https://icomoon.io/)
 
 
@@ -52,5 +53,5 @@ Gaël Métais. I'm a webperf freelance based in Paris. If you understand french,
 
 
 ## Contributors
-- [achrafbenyounes](https://github.com/achrafbenyounes)
+- Achraf Ben Younes [achrafbenyounes](https://github.com/achrafbenyounes)
 

BIN
screenshot.png