README.md (3255B)
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 # Strided 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 > Standard library strided. 26 27 <section class="installation"> 28 29 ## Installation 30 31 ```bash 32 npm install @stdlib/strided 33 ``` 34 35 </section> 36 37 <section class="usage"> 38 39 ## Usage 40 41 ```javascript 42 var ns = require( '@stdlib/strided' ); 43 ``` 44 45 #### ns 46 47 Standard library strided. 48 49 ```javascript 50 var o = ns; 51 // returns {...} 52 ``` 53 54 </section> 55 56 <!-- /.usage --> 57 58 <section class="examples"> 59 60 ## Examples 61 62 <!-- TODO: better examples --> 63 64 <!-- eslint no-undef: "error" --> 65 66 ```javascript 67 var objectKeys = require( '@stdlib/utils/keys' ); 68 var ns = require( '@stdlib/strided' ); 69 70 console.log( objectKeys( ns ) ); 71 ``` 72 73 </section> 74 75 <!-- /.examples --> 76 77 78 <section class="main-repo" > 79 80 * * * 81 82 ## Notice 83 84 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. 85 86 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]. 87 88 #### Community 89 90 [![Chat][chat-image]][chat-url] 91 92 --- 93 94 ## License 95 96 See [LICENSE][stdlib-license]. 97 98 99 ## Copyright 100 101 Copyright © 2016-2021. The Stdlib [Authors][stdlib-authors]. 102 103 </section> 104 105 <!-- /.stdlib --> 106 107 <!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. --> 108 109 <section class="links"> 110 111 [npm-image]: http://img.shields.io/npm/v/@stdlib/strided.svg 112 [npm-url]: https://npmjs.org/package/@stdlib/strided 113 114 [test-image]: https://github.com/stdlib-js/strided/actions/workflows/test.yml/badge.svg 115 [test-url]: https://github.com/stdlib-js/strided/actions/workflows/test.yml 116 117 [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/strided/main.svg 118 [coverage-url]: https://codecov.io/github/stdlib-js/strided?branch=main 119 120 [dependencies-image]: https://img.shields.io/david/stdlib-js/strided.svg 121 [dependencies-url]: https://david-dm.org/stdlib-js/strided/main 122 123 [chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg 124 [chat-url]: https://gitter.im/stdlib-js/stdlib/ 125 126 [stdlib]: https://github.com/stdlib-js/stdlib 127 128 [stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors 129 130 [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/strided/main/LICENSE 131 132 <!-- <toc-links> --> 133 134 <!-- </toc-links> --> 135 136 </section> 137 138 <!-- /.links -->