Rename ./src to ./lib

rochars · Jun 17, 2018 · 1173f53 · 1173f53
1 parent d9c0723
commit 1173f53
Show file tree

Hide file tree

Showing 11 changed files with 41 additions and 37 deletions.
diff --git a/README.md b/README.md
@@ -6,7 +6,7 @@ https://github.com/rochars/alawmulaw
 [![Codecov](https://img.shields.io/codecov/c/github/rochars/alawmulaw.svg?style=flat-square)](https://codecov.io/gh/rochars/alawmulaw) [![Unix Build](https://img.shields.io/travis/rochars/alawmulaw.svg?style=flat-square)](https://travis-ci.org/rochars/alawmulaw) [![Windows Build](https://img.shields.io/appveyor/ci/rochars/alawmulaw.svg?style=flat-square&logo=appveyor)](https://ci.appveyor.com/project/rochars/alawmulaw) [![Scrutinizer](https://img.shields.io/scrutinizer/g/rochars/alawmulaw.svg?style=flat-square&logo=scrutinizer)](https://scrutinizer-ci.com/g/rochars/alawmulaw/)
 
 ## About
-A-Law and μ-Law codecs for Node.js and the browser.
+A-Law and mu-Law codecs in JavaScript.
 
 ## Install
 ```

diff --git a/docs/index.html b/docs/index.html
@@ -48,7 +48,7 @@ <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-al
     <section class="readme">
         <article><h1>alawmulaw</h1><p>Copyright (c) 2018 Rafael da Silva Rocha.<br>https://github.com/rochars/alawmulaw</p>
 <p><a href="https://www.npmjs.com/package/alawmulaw"><img src="https://img.shields.io/npm/v/alawmulaw.svg?style=for-the-badge" alt="NPM version"></a> <a href="https://rochars.github.io/alawmulaw/index.html"><img src="https://img.shields.io/badge/docs-online-blue.svg?style=for-the-badge" alt="Docs"></a><br><a href="https://codecov.io/gh/rochars/alawmulaw"><img src="https://img.shields.io/codecov/c/github/rochars/alawmulaw.svg?style=flat-square" alt="Codecov"></a> <a href="https://travis-ci.org/rochars/alawmulaw"><img src="https://img.shields.io/travis/rochars/alawmulaw.svg?style=flat-square" alt="Unix Build"></a> <a href="https://ci.appveyor.com/project/rochars/alawmulaw"><img src="https://img.shields.io/appveyor/ci/rochars/alawmulaw.svg?style=flat-square&amp;logo=appveyor" alt="Windows Build"></a> <a href="https://scrutinizer-ci.com/g/rochars/alawmulaw/"><img src="https://img.shields.io/scrutinizer/g/rochars/alawmulaw.svg?style=flat-square&amp;logo=scrutinizer" alt="Scrutinizer"></a></p>
-<h2>About</h2><p>A-Law and μ-Law codecs for Node.js and the browser.</p>
+<h2>About</h2><p>A-Law and mu-Law codecs in JavaScript.</p>
 <h2>Install</h2><pre class="prettyprint source"><code>npm install alawmulaw</code></pre><h2>Browser</h2><p>Use the compiled file in the <em>/dist</em> folder:</p>
 <pre class="prettyprint source lang-html"><code>&lt;script src=&quot;alawmulaw.min.js&quot;>&lt;/script></code></pre><p>Or get it from the <a href="https://www.jsdelivr.com">jsDelivr</a> CDN:</p>
 <pre class="prettyprint source lang-html"><code>&lt;script src=&quot;https://cdn.jsdelivr.net/npm/alawmulaw@3/dist/alawmulaw.min.js&quot;>&lt;/script></code></pre><h2>Use</h2><h3>A-Law</h3><p>Full files:</p>
@@ -273,7 +273,7 @@ <h2>
 <header>
 
         <h2>
-        src/alaw.js
+        lib/alaw.js
         </h2>
 
 
@@ -289,7 +289,7 @@ <h2>
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="src_alaw.js.html">src/alaw.js</a>, <a href="src_alaw.js.html#line28">line 28</a>
+        <a href="lib_alaw.js.html">lib/alaw.js</a>, <a href="lib_alaw.js.html#line28">line 28</a>
     </li></ul></dd>
 
 
@@ -367,7 +367,7 @@ <h2>
 <header>
 
         <h2>
-        src/mulaw.js
+        lib/mulaw.js
         </h2>
 
 
@@ -383,7 +383,7 @@ <h2>
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="src_mulaw.js.html">src/mulaw.js</a>, <a href="src_mulaw.js.html#line28">line 28</a>
+        <a href="lib_mulaw.js.html">lib/mulaw.js</a>, <a href="lib_mulaw.js.html#line28">line 28</a>
     </li></ul></dd>
 
 
@@ -458,7 +458,7 @@ <h2>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sun Jun 17 2018 01:59:35 GMT-0300 (Hora oficial do Brasil) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sun Jun 17 2018 02:08:48 GMT-0300 (Hora oficial do Brasil) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/index.js.html b/docs/index.js.html
@@ -77,12 +77,12 @@ <h1 class="page-title">index.js</h1>
  * @export
  * @ignore
  */
-module.exports.alaw = require("./src/alaw");
+module.exports.alaw = require("./lib/alaw");
 /**
  * @export
  * @ignore
  */
-module.exports.mulaw = require("./src/mulaw");
+module.exports.mulaw = require("./lib/mulaw");
 </code></pre>
         </article>
     </section>
@@ -95,7 +95,7 @@ <h1 class="page-title">index.js</h1>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sun Jun 17 2018 01:59:35 GMT-0300 (Hora oficial do Brasil) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sun Jun 17 2018 02:08:48 GMT-0300 (Hora oficial do Brasil) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/src_alaw.js.html → docs/lib_alaw.js.html b/docs/src_alaw.js.html → docs/lib_alaw.js.html
@@ -2,7 +2,7 @@
 <html lang="en">
 <head>
     <meta charset="utf-8">
-    <title>src/alaw.js - Documentation</title>
+    <title>lib/alaw.js - Documentation</title>
 
     <script src="scripts/prettify/prettify.js"></script>
     <script src="scripts/prettify/lang-css.js"></script>
@@ -27,7 +27,7 @@ <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-al
 
 <div id="main">
 
-    <h1 class="page-title">src/alaw.js</h1>
+    <h1 class="page-title">lib/alaw.js</h1>
 
 
 
@@ -192,7 +192,7 @@ <h1 class="page-title">src/alaw.js</h1>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sun Jun 17 2018 01:59:35 GMT-0300 (Hora oficial do Brasil) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sun Jun 17 2018 02:08:48 GMT-0300 (Hora oficial do Brasil) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/src_mulaw.js.html → docs/lib_mulaw.js.html b/docs/src_mulaw.js.html → docs/lib_mulaw.js.html
@@ -2,7 +2,7 @@
 <html lang="en">
 <head>
     <meta charset="utf-8">
-    <title>src/mulaw.js - Documentation</title>
+    <title>lib/mulaw.js - Documentation</title>
 
     <script src="scripts/prettify/prettify.js"></script>
     <script src="scripts/prettify/lang-css.js"></script>
@@ -27,7 +27,7 @@ <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-al
 
 <div id="main">
 
-    <h1 class="page-title">src/mulaw.js</h1>
+    <h1 class="page-title">lib/mulaw.js</h1>
 
 
 
@@ -210,7 +210,7 @@ <h1 class="page-title">src/mulaw.js</h1>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sun Jun 17 2018 01:59:35 GMT-0300 (Hora oficial do Brasil) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sun Jun 17 2018 02:08:48 GMT-0300 (Hora oficial do Brasil) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/module-alawmulaw_alaw.html b/docs/module-alawmulaw_alaw.html
@@ -78,7 +78,7 @@ <h4 class="name" id=".decode"><span class="type-signature">(static) </span>decod
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="src_alaw.js.html">src/alaw.js</a>, <a href="src_alaw.js.html#line143">line 143</a>
+        <a href="lib_alaw.js.html">lib/alaw.js</a>, <a href="lib_alaw.js.html#line143">line 143</a>
     </li></ul></dd>
 
 
@@ -137,7 +137,7 @@ <h4 class="name" id=".decodeSample"><span class="type-signature">(static) </span
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="src_alaw.js.html">src/alaw.js</a>, <a href="src_alaw.js.html#line139">line 139</a>
+        <a href="lib_alaw.js.html">lib/alaw.js</a>, <a href="lib_alaw.js.html#line139">line 139</a>
     </li></ul></dd>
 
 
@@ -196,7 +196,7 @@ <h4 class="name" id=".encode"><span class="type-signature">(static) </span>encod
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="src_alaw.js.html">src/alaw.js</a>, <a href="src_alaw.js.html#line141">line 141</a>
+        <a href="lib_alaw.js.html">lib/alaw.js</a>, <a href="lib_alaw.js.html#line141">line 141</a>
     </li></ul></dd>
 
 
@@ -255,7 +255,7 @@ <h4 class="name" id=".encodeSample"><span class="type-signature">(static) </span
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="src_alaw.js.html">src/alaw.js</a>, <a href="src_alaw.js.html#line137">line 137</a>
+        <a href="lib_alaw.js.html">lib/alaw.js</a>, <a href="lib_alaw.js.html#line137">line 137</a>
     </li></ul></dd>
 
 
@@ -324,7 +324,7 @@ <h4 class="name" id="~decode"><span class="type-signature">(inner) </span>decode
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="src_alaw.js.html">src/alaw.js</a>, <a href="src_alaw.js.html#line127">line 127</a>
+        <a href="lib_alaw.js.html">lib/alaw.js</a>, <a href="lib_alaw.js.html#line127">line 127</a>
     </li></ul></dd>
 
 
@@ -475,7 +475,7 @@ <h4 class="name" id="~decodeSample"><span class="type-signature">(inner) </span>
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="src_alaw.js.html">src/alaw.js</a>, <a href="src_alaw.js.html#line84">line 84</a>
+        <a href="lib_alaw.js.html">lib/alaw.js</a>, <a href="lib_alaw.js.html#line84">line 84</a>
     </li></ul></dd>
 
 
@@ -626,7 +626,7 @@ <h4 class="name" id="~encode"><span class="type-signature">(inner) </span>encode
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="src_alaw.js.html">src/alaw.js</a>, <a href="src_alaw.js.html#line113">line 113</a>
+        <a href="lib_alaw.js.html">lib/alaw.js</a>, <a href="lib_alaw.js.html#line113">line 113</a>
     </li></ul></dd>
 
 
@@ -777,7 +777,7 @@ <h4 class="name" id="~encodeSample"><span class="type-signature">(inner) </span>
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="src_alaw.js.html">src/alaw.js</a>, <a href="src_alaw.js.html#line42">line 42</a>
+        <a href="lib_alaw.js.html">lib/alaw.js</a>, <a href="lib_alaw.js.html#line42">line 42</a>
     </li></ul></dd>
 
 
@@ -929,7 +929,7 @@ <h5>Returns:</h5>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sun Jun 17 2018 01:59:35 GMT-0300 (Hora oficial do Brasil) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sun Jun 17 2018 02:08:48 GMT-0300 (Hora oficial do Brasil) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/module-alawmulaw_mulaw.html b/docs/module-alawmulaw_mulaw.html
@@ -78,7 +78,7 @@ <h4 class="name" id=".decode"><span class="type-signature">(static) </span>decod
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="src_mulaw.js.html">src/mulaw.js</a>, <a href="src_mulaw.js.html#line161">line 161</a>
+        <a href="lib_mulaw.js.html">lib/mulaw.js</a>, <a href="lib_mulaw.js.html#line161">line 161</a>
     </li></ul></dd>
 
 
@@ -137,7 +137,7 @@ <h4 class="name" id=".decodeSample"><span class="type-signature">(static) </span
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="src_mulaw.js.html">src/mulaw.js</a>, <a href="src_mulaw.js.html#line157">line 157</a>
+        <a href="lib_mulaw.js.html">lib/mulaw.js</a>, <a href="lib_mulaw.js.html#line157">line 157</a>
     </li></ul></dd>
 
 
@@ -196,7 +196,7 @@ <h4 class="name" id=".encode"><span class="type-signature">(static) </span>encod
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="src_mulaw.js.html">src/mulaw.js</a>, <a href="src_mulaw.js.html#line159">line 159</a>
+        <a href="lib_mulaw.js.html">lib/mulaw.js</a>, <a href="lib_mulaw.js.html#line159">line 159</a>
     </li></ul></dd>
 
 
@@ -255,7 +255,7 @@ <h4 class="name" id=".encodeSample"><span class="type-signature">(static) </span
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="src_mulaw.js.html">src/mulaw.js</a>, <a href="src_mulaw.js.html#line155">line 155</a>
+        <a href="lib_mulaw.js.html">lib/mulaw.js</a>, <a href="lib_mulaw.js.html#line155">line 155</a>
     </li></ul></dd>
 
 
@@ -324,7 +324,7 @@ <h4 class="name" id="~decode"><span class="type-signature">(inner) </span>decode
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="src_mulaw.js.html">src/mulaw.js</a>, <a href="src_mulaw.js.html#line145">line 145</a>
+        <a href="lib_mulaw.js.html">lib/mulaw.js</a>, <a href="lib_mulaw.js.html#line145">line 145</a>
     </li></ul></dd>
 
 
@@ -475,7 +475,7 @@ <h4 class="name" id="~decodeSample"><span class="type-signature">(inner) </span>
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="src_mulaw.js.html">src/mulaw.js</a>, <a href="src_mulaw.js.html#line117">line 117</a>
+        <a href="lib_mulaw.js.html">lib/mulaw.js</a>, <a href="lib_mulaw.js.html#line117">line 117</a>
     </li></ul></dd>
 
 
@@ -626,7 +626,7 @@ <h4 class="name" id="~encode"><span class="type-signature">(inner) </span>encode
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="src_mulaw.js.html">src/mulaw.js</a>, <a href="src_mulaw.js.html#line131">line 131</a>
+        <a href="lib_mulaw.js.html">lib/mulaw.js</a>, <a href="lib_mulaw.js.html#line131">line 131</a>
     </li></ul></dd>
 
 
@@ -777,7 +777,7 @@ <h4 class="name" id="~encodeSample"><span class="type-signature">(inner) </span>
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="src_mulaw.js.html">src/mulaw.js</a>, <a href="src_mulaw.js.html#line90">line 90</a>
+        <a href="lib_mulaw.js.html">lib/mulaw.js</a>, <a href="lib_mulaw.js.html#line90">line 90</a>
     </li></ul></dd>
 
 
@@ -929,7 +929,7 @@ <h5>Returns:</h5>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sun Jun 17 2018 01:59:35 GMT-0300 (Hora oficial do Brasil) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sun Jun 17 2018 02:08:49 GMT-0300 (Hora oficial do Brasil) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/index.js b/index.js
@@ -38,9 +38,9 @@
  * @export
  * @ignore
  */
-module.exports.alaw = require("./src/alaw");
+module.exports.alaw = require("./lib/alaw");
 /**
  * @export
  * @ignore
  */
-module.exports.mulaw = require("./src/mulaw");
+module.exports.mulaw = require("./lib/mulaw");
diff --git a/src/alaw.js → lib/alaw.js b/src/alaw.js → lib/alaw.js
diff --git a/src/mulaw.js → lib/mulaw.js b/src/mulaw.js → lib/mulaw.js
diff --git a/package.json b/package.json
@@ -24,12 +24,16 @@
   "bugs": {
     "url": "https://github.com/rochars/alawmulaw/issues"
   },
+  "directories": {
+    "doc": "./docs",
+    "lib": "./lib"
+  },
   "scripts": {
     "lint": "jshint index.js",
     "test": "nyc ./node_modules/mocha/bin/_mocha test --src --recursive",
     "test-dist": "nyc ./node_modules/mocha/bin/_mocha test  --dist --recursive",
     "coverage": "nyc report --reporter=lcov > coverage.lcov && codecov",
-    "doc": "./node_modules/.bin/jsdoc index.js src -d docs -r README.md -t node_modules/docdash",
+    "doc": "./node_modules/.bin/jsdoc index.js lib -d docs -r README.md -t node_modules/docdash",
     "pack": "webpack && npm run test-dist",
     "build": "npm run lint && npm run test && npm run pack && npm run doc",
     "build-ci": "npm run lint && npm run pack && npm run test && npm run doc"