diff --git a/.editorconfig b/.editorconfig index 0fd4d6c..13e9c39 100644 --- a/.editorconfig +++ b/.editorconfig @@ -179,3 +179,8 @@ indent_size = 2 [*.gypi] indent_style = space indent_size = 2 + +# Set properties for citation files: +[*.{cff,cff.txt}] +indent_style = space +indent_size = 2 diff --git a/CITATION.cff b/CITATION.cff new file mode 100644 index 0000000..2ec6fff --- /dev/null +++ b/CITATION.cff @@ -0,0 +1,30 @@ +cff-version: 1.2.0 +title: stdlib +message: >- + If you use this software, please cite it using the + metadata from this file. + +type: software + +authors: + - name: The Stdlib Authors + url: https://github.com/stdlib-js/stdlib/graphs/contributors + +repository-code: https://github.com/stdlib-js/stdlib +url: https://stdlib.io + +abstract: | + Standard library for JavaScript and Node.js. + +keywords: + - JavaScript + - Node.js + - TypeScript + - standard library + - scientific computing + - numerical computing + - statistical computing + +license: Apache-2.0 AND BSL-1.0 + +date-released: 2016 diff --git a/README.md b/README.md index a2e36a5..f60f7c4 100644 --- a/README.md +++ b/README.md @@ -18,6 +18,17 @@ limitations under the License. --> + +
+ + About stdlib... + +

We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.

+

The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.

+

When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.

+

To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!

+
+ # Circular Buffer [![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] @@ -406,8 +417,8 @@ Copyright © 2016-2023. The Stdlib [Authors][stdlib-authors]. [npm-image]: http://img.shields.io/npm/v/@stdlib/utils-circular-buffer.svg [npm-url]: https://npmjs.org/package/@stdlib/utils-circular-buffer -[test-image]: https://github.com/stdlib-js/utils-circular-buffer/actions/workflows/test.yml/badge.svg?branch=main -[test-url]: https://github.com/stdlib-js/utils-circular-buffer/actions/workflows/test.yml?query=branch:main +[test-image]: https://github.com/stdlib-js/utils-circular-buffer/actions/workflows/test.yml/badge.svg?branch=v0.1.0 +[test-url]: https://github.com/stdlib-js/utils-circular-buffer/actions/workflows/test.yml?query=branch:v0.1.0 [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/utils-circular-buffer/main.svg [coverage-url]: https://codecov.io/github/stdlib-js/utils-circular-buffer?branch=main diff --git a/docs/types/index.d.ts b/docs/types/index.d.ts index e193355..3377085 100644 --- a/docs/types/index.d.ts +++ b/docs/types/index.d.ts @@ -16,7 +16,7 @@ * limitations under the License. */ -// TypeScript Version: 2.0 +// TypeScript Version: 4.1 /// diff --git a/package.json b/package.json index 42f672d..c4ca51f 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@stdlib/utils-circular-buffer", - "version": "0.0.7", + "version": "0.1.0", "description": "Circular buffer.", "license": "Apache-2.0", "author": { @@ -37,24 +37,24 @@ "url": "https://github.com/stdlib-js/stdlib/issues" }, "dependencies": { - "@stdlib/array-base-arraylike2object": "^0.0.2", - "@stdlib/assert-is-collection": "^0.0.8", - "@stdlib/assert-is-nonnegative-integer": "^0.0.7", - "@stdlib/assert-is-positive-integer": "^0.0.7", - "@stdlib/constants-float64-max": "^0.0.8", - "@stdlib/string-format": "^0.0.3", - "@stdlib/symbol-iterator": "^0.0.7", - "@stdlib/types": "^0.0.14", - "@stdlib/utils-define-nonenumerable-read-only-accessor": "^0.0.7", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.0.7" + "@stdlib/array-base-arraylike2object": "^0.1.0", + "@stdlib/assert-is-collection": "^0.1.0", + "@stdlib/assert-is-nonnegative-integer": "^0.1.0", + "@stdlib/assert-is-positive-integer": "^0.1.0", + "@stdlib/constants-float64-max": "^0.1.0", + "@stdlib/string-format": "^0.1.0", + "@stdlib/symbol-iterator": "^0.1.0", + "@stdlib/types": "^0.1.0", + "@stdlib/utils-define-nonenumerable-read-only-accessor": "^0.1.0", + "@stdlib/utils-define-nonenumerable-read-only-property": "^0.1.0" }, "devDependencies": { - "@stdlib/array-complex128": "^0.0.6", - "@stdlib/assert-instance-of": "^0.0.8", - "@stdlib/bench": "^0.0.12", - "@stdlib/complex-float64": "^0.0.8", - "@stdlib/complex-imag": "^0.0.7", - "@stdlib/complex-real": "^0.0.7", + "@stdlib/array-complex128": "^0.1.0", + "@stdlib/assert-instance-of": "^0.1.0", + "@stdlib/bench": "^0.1.0", + "@stdlib/complex-float64": "^0.1.0", + "@stdlib/complex-imag": "^0.1.0", + "@stdlib/complex-real": "^0.1.0", "@stdlib/random-base-randu": "^0.0.8", "proxyquire": "^2.0.0", "tape": "git+https://github.com/kgryte/tape.git#fix/globby",