Skip to content

Commit

Permalink
release: 0.0.3
Browse files Browse the repository at this point in the history
- [x] added doc notes.
  • Loading branch information
boan-anbo committed Nov 14, 2023
1 parent 5ea3984 commit 8d45bf0
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 5 deletions.
12 changes: 9 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,13 @@
[![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
# Notes

Cantos is in eperimental phase with regular breaking changes.

Changelog will be added with `v0.1.0`. Until then, you can

- check the source code for documentation and commits for changelog, and
- check [tests](packages/cantos/tests) for current working examples.

# Cantos: Write Better Tests

Expand All @@ -24,8 +31,7 @@ pnpm add -D cantos

### Quick Tutorial: An AI Chat App

https://github.com/boan-anbo/better-tests/blob/77cc7005ab989b258fb5ee377d92f73ed1cd44f6/packages/cantos/tests/tutorials/cantos-basics-mychat.test.ts#L1-L10

See [Basic Tutorial](./packages/cantos/tests/tutorials/cantos-basics-mychat.test.ts).

## What Cantos does

Expand Down
5 changes: 3 additions & 2 deletions packages/cantos/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"name": "cantos",
"private": false,
"author": "Bo An",
"version": "0.0.2",
"version": "0.0.3",
"keywords": [
"User Stories",
"TDD",
Expand Down Expand Up @@ -47,7 +47,8 @@
"preview": "vite preview",
"test": "vitest",
"test:ui": "vitest --ui",
"mermaid": "^10.6.1"
"mermaid": "^10.6.1",
"publish": "yarn build && npm publish"
},
"devDependencies": {
"@types/node": "^20.9.0",
Expand Down

0 comments on commit 8d45bf0

Please sign in to comment.