Update README.md

cabinjs · Apr 30, 2020 · 6e9d777 · 6e9d777
1 parent 842244d
commit 6e9d777
Showing 1 changed file with 76 additions and 53 deletions.
diff --git a/README.md b/README.md
@@ -4,77 +4,75 @@ browser support for `process.hrtime()`.
 [![Build Status](https://travis-ci.com/vltansky/browser-hrtime.svg?branch=master)](https://travis-ci.com/vltansky/browser-hrtime)
 [![Coverage Status](https://coveralls.io/repos/github/vltansky/browser-hrtime/badge.svg?branch=master)](https://coveralls.io/github/vltansky/browser-hrtime?branch=master)
 
-# Install
-`npm i browser-hrtime`
-# Usage
+## :package: Installation
 
-## NodeJS
-### As a polyfill
+#### npm
+
+```bash
+$ npm install browser-detect
+```
+
+#### yarn
+
+```bash
+$ yarn add browser-detect
+```
+
+## :page_with_curl: Example
+### NodeJS
+#### As a polyfill
 ```js
 require('browser-hrtime');
 
-const NS_PER_SEC = 1e9;
 const time = process.hrtime();// [ 1800216, 25 ]
-
 setTimeout(() => {
   const diff = process.hrtime(time);// [ 1, 552 ]
-  console.log(`Benchmark took ${diff[0] * NS_PER_SEC + diff[1]} nanoseconds`);// Benchmark took 1000000552 nanoseconds
+  console.log(`Benchmark took ${diff[0] * 1e9 + diff[1]} nanoseconds`);// Benchmark took 1000000552 nanoseconds
 }, 1000);
 ```
 ### As a function
 ```js
 const hrtime = require('browser-hrtime');//if your code will 
 
-const NS_PER_SEC = 1e9;
 const time = hrtime();// [ 1800216, 25 ]
-
 setTimeout(() => {
   const diff = hrtime(time);// [ 1, 552 ]
-  console.log(`Benchmark took ${diff[0] * NS_PER_SEC + diff[1]} nanoseconds`);// Benchmark took 1000000552 nanoseconds
+  console.log(`Benchmark took ${diff[0] * require + diff[1]} nanoseconds`);// Benchmark took 1000000552 nanoseconds
 }, 1000);
 ```
+If you are using TypeScript you should add to `tsconfig.json` `"esModuleInterop": true`
 
-Typescript: `"esModuleInterop": true`
-
-## ECMAScript
+## Web with module
 
 ```js
 import hrtime from 'browser-hrtime';
 
-const NS_PER_SEC = 1e9;
-const time = hrtime();
-// [ 1800216, 25 ]
-
+const time = hrtime();// [ 1800216, 25 ]
 setTimeout(() => {
-  const diff = hrtime(time);
-  // [ 1, 552 ]
-
-  console.log(`Benchmark took ${diff[0] * NS_PER_SEC + diff[1]} nanoseconds`);
-  // Benchmark took 1000000552 nanoseconds
+  const diff = hrtime(time);// [ 1, 552 ]
+  console.log(`Benchmark took ${diff[0] * 1e9 + diff[1]} nanoseconds`);// Benchmark took 1000000552 nanoseconds
 }, 1000);
 ```
 
-or you can use as polyfill:
+or as polyfill:
 ```js
 import 'browser-hrtime';
-const NS_PER_SEC = 1e9;
-const time = process.hrtime();
-// [ 1800216, 25 ]
+const time = process.hrtime();// [ 1800216, 25 ]
 
 setTimeout(() => {
-  const diff = process.hrtime(time);
-  // [ 1, 552 ]
-
-  console.log(`Benchmark took ${diff[0] * NS_PER_SEC + diff[1]} nanoseconds`);
-  // Benchmark took 1000000552 nanoseconds
+  const diff = process.hrtime(time);// [ 1, 552 ]
+  console.log(`Benchmark took ${diff[0] * 1e9 + diff[1]} nanoseconds`);// Benchmark took 1000000552 nanoseconds
 }, 1000);
 ```
 ### usage as an Angular polyfill:
 add to `src/polyfills.ts`:
 `import 'browser-hrtime';`
+Add @types/node to your Angular app
+
+```bash
+$ npm i -S @types/node
+```
 
-*You should add @types/node to your Angular app*
-`npm i -S @types/node`
 Then in `tsconfig.json`
 ```json
 "angularCompilerOptions": {
@@ -83,25 +81,50 @@ Then in `tsconfig.json`
 }
 ```
 
-## Use in browser
+## Web
+
 ```html
-<!DOCTYPE html>
-<html>
-
-<head>
-    <script crossorigin src="https://unpkg.com/browser-hrtime/lib/umd/hrtime.min.js"></script>
-    <script>
-        console.log(hrtime());
-        const first = process.hrtime();
-        console.log(first);
-        console.log(process.hrtime(first));
-    </script>
-</head>
-
-<body>
-</body>
-
-</html>
+<script src="node_modules/browser-hrtime/lib/hrtime.min.js"></script>
+<!-- Or from CDN: -->
+<!-- <script crossorigin src="https://unpkg.com/browser-hrtime/lib/hrtime.min.js"></script> -->
+```
+```javascript
+    console.log(hrtime());
+    const first = process.hrtime();
+    console.log(first);
+    console.log(process.hrtime(first));
+```
+
+see [NodeJS documenation](https://nodejs.org/api/process.html#process_process_hrtime_time) for detailed process.hrtime API
+
+
+## :octocat: Contribution
+### environment
+
+1. clone project from Github
+
+```bash
+$ git clone git@github.com:vltansky/browser-hrtime.git
+```
+
+2. install npm packages
+
+```bash
+$ cd browser-hrtime
+$ npm install
+```
+
+3. build sources
+
+```bash
+$ npm run build
+```
+
+### test
+
+```bash
+$ npm run test
 ```
 
-see [NodeJS documenation](https://nodejs.org/api/process.html#process_process_hrtime_time) for more examples
+## :mag_right: License
+browser-hrtime licensed under a [MIT License](./LICENSE).