Skip to content

Commit

Permalink
docs(WIP): added installation and quick tutorial
Browse files Browse the repository at this point in the history
  • Loading branch information
boan-anbo committed Nov 13, 2023
1 parent c729b6c commit 9add071
Showing 1 changed file with 23 additions and 3 deletions.
26 changes: 23 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
README WIP, see [tests](packages/cantos/tests) for working examples
---
[![npm version](https://badge.fury.io/js/cantos.svg)](https://badge.fury.io/js/cantos)

> README WIP, see [tests](packages/cantos/tests) for working examples
# Cantos: Write Better Tests

Expand All @@ -8,11 +9,24 @@ with easy, and support test-driven and/or behavior-driven development.

## Quick Start

```ts
### Installation

```bash
# NPM
npm install -D cantos

# Yarn
yarn add -D cantos

# Pnpm
pnpm add -D cantos
```

### Quick Tutorial: An AI Chat App

https://github.com/boan-anbo/better-tests/blob/c729b6cd25487dc38f4eecd1923b025d0b1cd80b/packages/cantos/tests/tutorials/cantos-basics-mychat.test.ts#L2


## What Cantos does

### Cantos provides a way to think through your software
Expand Down Expand Up @@ -189,6 +203,12 @@ Sometimes, this is inevitable as part of the process of development, but sometim

- It works great with CoPilot because it has a clear structure to infer from.

## Tips

### The story instances are protected with read-only types to prevent accidental mutations.

If you need to mutate your stories, change the story scripts, which should be the single source of truth for your stories.

## Glossary

GWT
Expand Down

0 comments on commit 9add071

Please sign in to comment.