Skip to content

Commit

Permalink
📚 docs: Move from README to docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
make-github-pseudonymous-again committed Apr 28, 2020
1 parent a8203cc commit c638cf2
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 16 deletions.
17 changes: 1 addition & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ List ADT specification code bricks for Javascript. Parent is
[aureooms/js-data-structures](https://github.com/aureooms/js-data-structures).

```js
listspec.test( "My list implementation" , MyListConstructor ) ;
spec.test( ava , "My list implementation" , MyListConstructor ) ;
```

[![License](https://img.shields.io/github/license/aureooms/js-list-spec.svg)](https://raw.githubusercontent.com/aureooms/js-list-spec/master/LICENSE)
Expand All @@ -22,18 +22,3 @@ listspec.test( "My list implementation" , MyListConstructor ) ;
[![Code technical debt](https://img.shields.io/codeclimate/tech-debt/aureooms/js-list-spec.svg)](https://codeclimate.com/github/aureooms/js-list-spec/trends/technical_debt)
[![Documentation](https://aureooms.github.io/js-list-spec//badge.svg)](https://aureooms.github.io/js-list-spec//source.html)
[![Package size](https://img.shields.io/bundlephobia/minzip/@aureooms/js-list-spec)](https://bundlephobia.com/result?p=@aureooms/js-list-spec)

## Description

This repository provides easy methods to test the implementation of a list
abstract data type. The specification of such a data type will be provided in
[@aureooms/js-list-doc](https://aureooms.github.io/js-list-doc) later.

## Use

Currently, you can do the following to test your implementation:

```javascript
let spec = require( "@aureooms/js-list-spec" ) ;
spec.test( "My list implementation" , MyListConstructor ) ;
```
8 changes: 8 additions & 0 deletions doc/manual/example.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
# Examples

> More examples in [the test files](https://github.com/aureooms/js-list-spec/tree/master/test/src).
Currently, you can do the following to test your implementation:

```javascript
import test from 'ava' ;
import * as spec from '@aureooms/js-list-spec' ;
spec.test( test , "My list implementation" , MyListConstructor ) ;
```
4 changes: 4 additions & 0 deletions doc/manual/overview.md
Original file line number Diff line number Diff line change
@@ -1 +1,5 @@
# Overview

This repository provides convenience methods to test the implementation of a list
abstract data type. The specification of such a data type will be provided in
[@aureooms/js-list-doc](https://aureooms.github.io/js-list-doc) later.

0 comments on commit c638cf2

Please sign in to comment.