time-to-botec

Benchmark sampling in different programming languages
Log | Files | Refs | README

README.md (3582B)

      1 <!--
      2 
      3 @license Apache-2.0
      4 
      5 Copyright (c) 2021 The Stdlib Authors.
      6 
      7 Licensed under the Apache License, Version 2.0 (the "License");
      8 you may not use this file except in compliance with the License.
      9 You may obtain a copy of the License at
     10 
     11    http://www.apache.org/licenses/LICENSE-2.0
     12 
     13 Unless required by applicable law or agreed to in writing, software
     14 distributed under the License is distributed on an "AS IS" BASIS,
     15 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
     16 See the License for the specific language governing permissions and
     17 limitations under the License.
     18 
     19 -->
     20 
     21 # CLI
     22 
     23 [![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] [![dependencies][dependencies-image]][dependencies-url]
     24 
     25 > Command-line interface namespace.
     26 
     27 <section class="installation">
     28 
     29 ## Installation
     30 
     31 ```bash
     32 npm install @stdlib/cli
     33 ```
     34 
     35 </section>
     36 
     37 <section class="usage">
     38 
     39 ## Usage
     40 
     41 ```javascript
     42 var ns = require( '@stdlib/cli' );
     43 ```
     44 
     45 #### ns
     46 
     47 Command-line interface namespace.
     48 
     49 ```javascript
     50 var o = ns;
     51 // returns {...}
     52 ```
     53 
     54 The namespace contains the following:
     55 
     56 <!-- <toc pattern="*"> -->
     57 
     58 <div class="namespace-toc">
     59 
     60 -   <span class="signature">[`CLI( [options] )`][@stdlib/cli/ctor]</span><span class="delimiter">: </span><span class="description">command-line interface.</span>
     61 
     62 </div>
     63 
     64 <!-- </toc> -->
     65 
     66 </section>
     67 
     68 <!-- /.usage -->
     69 
     70 <section class="examples">
     71 
     72 ## Examples
     73 
     74 <!-- TODO: better examples -->
     75 
     76 <!-- eslint no-undef: "error" -->
     77 
     78 ```javascript
     79 var objectKeys = require( '@stdlib/utils/keys' );
     80 var ns = require( '@stdlib/cli' );
     81 
     82 console.log( objectKeys( ns ) );
     83 ```
     84 
     85 </section>
     86 
     87 <!-- /.examples -->
     88 
     89 
     90 <section class="main-repo" >
     91 
     92 * * *
     93 
     94 ## Notice
     95 
     96 This package is part of [stdlib][stdlib], a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.
     97 
     98 For more information on the project, filing bug reports and feature requests, and guidance on how to develop [stdlib][stdlib], see the main project [repository][stdlib].
     99 
    100 #### Community
    101 
    102 [![Chat][chat-image]][chat-url]
    103 
    104 ---
    105 
    106 ## License
    107 
    108 See [LICENSE][stdlib-license].
    109 
    110 
    111 ## Copyright
    112 
    113 Copyright &copy; 2016-2021. The Stdlib [Authors][stdlib-authors].
    114 
    115 </section>
    116 
    117 <!-- /.stdlib -->
    118 
    119 <!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
    120 
    121 <section class="links">
    122 
    123 [npm-image]: http://img.shields.io/npm/v/@stdlib/cli.svg
    124 [npm-url]: https://npmjs.org/package/@stdlib/cli
    125 
    126 [test-image]: https://github.com/stdlib-js/cli/actions/workflows/test.yml/badge.svg
    127 [test-url]: https://github.com/stdlib-js/cli/actions/workflows/test.yml
    128 
    129 [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/cli/main.svg
    130 [coverage-url]: https://codecov.io/github/stdlib-js/cli?branch=main
    131 
    132 [dependencies-image]: https://img.shields.io/david/stdlib-js/cli.svg
    133 [dependencies-url]: https://david-dm.org/stdlib-js/cli/main
    134 
    135 [chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
    136 [chat-url]: https://gitter.im/stdlib-js/stdlib/
    137 
    138 [stdlib]: https://github.com/stdlib-js/stdlib
    139 
    140 [stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
    141 
    142 [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/cli/main/LICENSE
    143 
    144 <!-- <toc-links> -->
    145 
    146 [@stdlib/cli/ctor]: https://www.npmjs.com/package/@stdlib/cli/tree/main/ctor
    147 
    148 <!-- </toc-links> -->
    149 
    150 </section>
    151 
    152 <!-- /.links -->