Skip to content

Commit

Permalink
Merge pull request #3 from stacks-network/readme-update
Browse files Browse the repository at this point in the history
Update README.md
  • Loading branch information
MarvinJanssen committed Mar 27, 2024
2 parents d894990 + f73cdf8 commit 04a678a
Showing 1 changed file with 2 additions and 6 deletions.
8 changes: 2 additions & 6 deletions packages/clarunit/README.md
Expand Up @@ -7,13 +7,9 @@ detect test files and test functions.
An example Clarinet-sdk project using `clarunit` can be found in the `example`
folder.

**Note:** this is a pre-release to be able to both use the `clarunit` workflow
as well as evaluate it. The package will eventually be moved into a monorepo
and properly published on NPM under the Stacks organisation.

## Setup

1. Install this repository as a dependency using `npm` or `yarn`. (Be sure to
1. Install package `@stacks/clarunit` using your favourite package manager. (Be sure to
pin the version!)
2. Create a test file in your existing `tests` folder, you can use any name but
using `clarunit.test.ts` is recommended.
Expand Down Expand Up @@ -125,4 +121,4 @@ Examples:
;; @name Five blocks are mined before this test is executed.
;; @mine-blocks-before 5
(define-public (test-six) (ok true))
```
```

0 comments on commit 04a678a

Please sign in to comment.