Skip to content

Commit

Permalink
Fixed minor lbroken links in readme after merging feature/typescript …
Browse files Browse the repository at this point in the history
…into main.
  • Loading branch information
abrisene committed Sep 7, 2021
1 parent 155fd95 commit 42a1e97
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 23 deletions.
19 changes: 8 additions & 11 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
# _acausal_ [![stable](http://badges.github.io/stability-badges/dist/stable.svg)](http://github.com/badges/stability-badges)
# acausal

[![npm version](https://badge.fury.io/js/acausal.svg)](https://badge.fury.io/js/acausal) [![GitHub version](https://badge.fury.io/gh/abrisene%2Facausal.svg)](https://badge.fury.io/gh/abrisene%2Facausal) [![Build Status](https://travis-ci.com/abrisene/acausal.svg?branch=main)](https://travis-ci.com/abrisene/acausal) [![Coverage Status](https://coveralls.io/repos/github/abrisene/acausal/badge.svg?branch=feature/typescript)](https://coveralls.io/github/abrisene/acausal?branch=feature/typescript)

**Note: This is a beta release. API stability and documentation completeness are not guaranteed.**
[![npm version](https://badge.fury.io/js/acausal.svg)](https://badge.fury.io/js/acausal) [![GitHub version](https://badge.fury.io/gh/abrisene%2Facausal.svg)](https://badge.fury.io/gh/abrisene%2Facausal) [![Build Status](https://app.travis-ci.com/abrisene/acausal.svg?branch=master)](https://app.travis-ci.com/abrisene/acausal) [![stability-stable](https://img.shields.io/badge/stability-stable-green.svg)](https://github.com/emersion/stability-badges#stable) [![Coverage Status](https://coveralls.io/repos/github/abrisene/acausal/badge.svg?branch=master)](https://coveralls.io/github/abrisene/acausal?branch=master)

*acausal* is a Typescript module that makes it easy to create, edit and generate pseudo random data from **Weighted Random Distributions** and **Markov Chains**.

Expand Down Expand Up @@ -57,9 +55,9 @@ rand.integer(1, 6); // Roll 1d6

## Quick Links

- [_acausal_ Home](https://abrisene.github.io/acausal/)
- [Random Distribution Quickstart](https://abrisene.github.io/acausal/readme/distribution.md)
- [Markov Chain Quickstart](https://abrisene.github.io/acausal/readme/markov.md)
- [_acausal_ Home](https://github.com/abrisene/acausal/#readme)
- [Random Distribution Quickstart](https://github.com/abrisene/acausal/blob/master/readme/distribution.md#acausal-)
- [Markov Chain Quickstart](https://github.com/abrisene/acausal/blob/master/readme/markov.md#acausal-)

## Installation

Expand Down Expand Up @@ -149,8 +147,7 @@ console.log(picks);
*/
```

You can learn more about how to use Random Distributions with _acausal_ in the
[Random Distribution Quickstart](https://abrisene.github.io/acausal/readme/distribution.md).
You can learn more about how to use Random Distributions with _acausal_ in the [Random Distribution Quickstart](https://github.com/abrisene/acausal/blob/master/readme/distribution.md#acausal-).

## Markov Chains

Expand Down Expand Up @@ -214,9 +211,9 @@ for (let i = 0; i < 3; i += 1) {
*/
```

You can learn more about how to use Markov Chains with _acausal_ in the [Markov Chain Quickstart](https://abrisene.github.io/acausal/readme/markov.md).
You can learn more about how to use Markov Chains with _acausal_ in the [Markov Chain Quickstart](https://github.com/abrisene/acausal/blob/master/readme/markov.md#acausal-)


## Extended API Documentation

For documentation of underlying classes and functions, please see the [docs](https://abrisene.github.io/acausal/modules.html).
For documentation of underlying classes and functions, please see the [API documentation](https://github.com/abrisene/acausal/modules.html).
12 changes: 6 additions & 6 deletions readme/distribution.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# acausal [![stable](http://badges.github.io/stability-badges/dist/stable.svg)](http://github.com/badges/stability-badges)
# acausal

[![npm version](https://badge.fury.io/js/acausal.svg)](https://badge.fury.io/js/acausal) [![GitHub version](https://badge.fury.io/gh/abrisene%2Facausal.svg)](https://badge.fury.io/gh/abrisene%2Facausal) [![Build Status](https://travis-ci.com/abrisene/acausal.svg?branch=main)](https://travis-ci.com/abrisene/acausal) [![Coverage Status](https://coveralls.io/repos/github/abrisene/acausal/badge.svg?branch=feature/typescript)](https://coveralls.io/github/abrisene/acausal?branch=feature/typescript)
[![npm version](https://badge.fury.io/js/acausal.svg)](https://badge.fury.io/js/acausal) [![GitHub version](https://badge.fury.io/gh/abrisene%2Facausal.svg)](https://badge.fury.io/gh/abrisene%2Facausal) [![Build Status](https://app.travis-ci.com/abrisene/acausal.svg?branch=master)](https://app.travis-ci.com/abrisene/acausal) [![stability-stable](https://img.shields.io/badge/stability-stable-green.svg)](https://github.com/emersion/stability-badges#stable) [![Coverage Status](https://coveralls.io/repos/github/abrisene/acausal/badge.svg?branch=master)](https://coveralls.io/github/abrisene/acausal?branch=master)

## Random Distributions

- [_acausal_ Home](https://abrisene.github.io/acausal/)
- [Markov Chain Quickstart](https://abrisene.github.io/acausal/readme/markov.md)
- [_acausal_ Home](https://github.com/abrisene/acausal/#readme)
- [Markov Chain Quickstart](https://github.com/abrisene/acausal/blob/master/readme/markov.md#acausal-)

A **Random Distribution** is a simple model which can simulate picks from a weighted distribution of items.

Expand Down Expand Up @@ -299,6 +299,6 @@ const p5c = Distribution.pick(jarData, 5, undefined, true, rng);
```

### Extended Distribution API Documentation
For documentation of underlying classes and functions, please see the [Distribution Class documentation](https://abrisene.github.io/acausal/modules/structures_distribution.html).
For documentation of underlying classes and functions, please see the [Distribution Class documentation](https://github.com/abrisene/acausal/modules/structures_distribution.html).

## Next: [Markov Chain Quickstart](https://abrisene.github.io/acausal/readme/markov.md)
## Next: [Markov Chain Quickstart](https://github.com/abrisene/acausal/blob/master/readme/markov.md#acausal-)
12 changes: 6 additions & 6 deletions readme/markov.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# acausal [![stable](http://badges.github.io/stability-badges/dist/stable.svg)](http://github.com/badges/stability-badges)
# acausal

[![npm version](https://badge.fury.io/js/acausal.svg)](https://badge.fury.io/js/acausal) [![GitHub version](https://badge.fury.io/gh/abrisene%2Facausal.svg)](https://badge.fury.io/gh/abrisene%2Facausal) [![Build Status](https://travis-ci.com/abrisene/acausal.svg?branch=main)](https://travis-ci.com/abrisene/acausal) [![Coverage Status](https://coveralls.io/repos/github/abrisene/acausal/badge.svg?branch=feature/typescript)](https://coveralls.io/github/abrisene/acausal?branch=feature/typescript)
[![npm version](https://badge.fury.io/js/acausal.svg)](https://badge.fury.io/js/acausal) [![GitHub version](https://badge.fury.io/gh/abrisene%2Facausal.svg)](https://badge.fury.io/gh/abrisene%2Facausal) [![Build Status](https://app.travis-ci.com/abrisene/acausal.svg?branch=master)](https://app.travis-ci.com/abrisene/acausal) [![stability-stable](https://img.shields.io/badge/stability-stable-green.svg)](https://github.com/emersion/stability-badges#stable) [![Coverage Status](https://coveralls.io/repos/github/abrisene/acausal/badge.svg?branch=master)](https://coveralls.io/github/abrisene/acausal?branch=master)


## Markov Chains

- [_acausal_ Home](https://abrisene.github.io/acausal/)
- [Random Distribution Quickstart](https://abrisene.github.io/acausal/readme/distribution.md)
- [_acausal_ Home](https://github.com/abrisene/acausal/#readme)
- [Random Distribution Quickstart](https://github.com/abrisene/acausal/blob/master/readme/distribution.md#acausal-)

A **Markov Chain** is a mathematical model of a system in which the future state of the system depends only on its present state.

Expand Down Expand Up @@ -424,6 +424,6 @@ const s1e = MarkovChain.generate({
```

## Extended Markov API Documentation
For more documentation of underlying functions, please see the [Markov Chain class documentation](https://abrisene.github.io/acausal/modules/structures_markov.html).
For more documentation of underlying functions, please see the [Markov Chain class documentation](https://github.com/abrisene/acausal/modules/structures_markov.html).

## Next: [Home](https://abrisene.github.io/acausal/readme.md)
## Next: [Home](https://github.com/abrisene/acausal/#readme)

0 comments on commit 42a1e97

Please sign in to comment.