Skip to content

Commit

Permalink
Fixed API links to github pages. Added a note about dependencies in d…
Browse files Browse the repository at this point in the history
…esign philosophy.
  • Loading branch information
abrisene committed Sep 7, 2021
1 parent 42a1e97 commit 60a0780
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 4 deletions.
5 changes: 3 additions & 2 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,9 @@

**Design Philosophy**
- **Immutable:** all classes are built on top of pure functions which do not mutate state, ensuring that models retain their integrity, and making them easy to use with Redux.
- **Portable:** all classes are easily serializable and deserializable into data transfer objects, making them easy to store and rebuild regardless of whether it's on the client or the server.
- **Portable:** all classes are easily serializable and deserializable into data transfer objects, making them easy to store, transfer, and rebuild regardless of whether it's on the client or the server.
- **Easy to Use:** all APIs are written to prioritize developer usability, making it easy to rapidly prototype and implement new models.
- **Minimal Dependencies**: _acausal_ only depends on [random-js](https://www.npmjs.com/package/random-js) and [scalr](https://www.npmjs.com/package/scalr), (which formerly was part of _acausal_, but separated out for the 2.0.0 release).


**Basic Examples:**
Expand Down Expand Up @@ -216,4 +217,4 @@ You can learn more about how to use Markov Chains with _acausal_ in the [Markov

## Extended API Documentation

For documentation of underlying classes and functions, please see the [API documentation](https://github.com/abrisene/acausal/modules.html).
For documentation of underlying classes and functions, please see the [API documentation](https://abrisene.github.io/acausal/modules.html).
2 changes: 1 addition & 1 deletion readme/distribution.md
Original file line number Diff line number Diff line change
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://github.com/abrisene/acausal/modules/structures_distribution.html).
For documentation of underlying classes and functions, please see the [Distribution Class documentation](https://abrisene.github.io/acausal/modules/structures_distribution.html).

## Next: [Markov Chain Quickstart](https://github.com/abrisene/acausal/blob/master/readme/markov.md#acausal-)
2 changes: 1 addition & 1 deletion readme/markov.md
Original file line number Diff line number Diff line change
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://github.com/abrisene/acausal/modules/structures_markov.html).
For more documentation of underlying functions, please see the [Markov Chain class documentation](https://abrisene.github.io/acausal/modules/structures_markov.html).

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

0 comments on commit 60a0780

Please sign in to comment.