Skip to content

Commit

Permalink
docs: improve documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
wellwelwel committed Feb 13, 2024
1 parent 8a82e85 commit 0420a3b
Show file tree
Hide file tree
Showing 4 changed files with 59 additions and 4 deletions.
3 changes: 3 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Code of Conduct

1. Please, **be respectful** 💛
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2024-current Weslley Araújo (@wellwelwel)

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
36 changes: 33 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

<img align="right" width="128" height="128" alt="Logo" src=".github/assets/readme/poku.svg">

🐽 A flexible and user-friendly **Test Runner** which allows parallel runs and high isolation level.
🖇️ A flexible and user-friendly **Test Runner** which allows parallel runs and high isolation level.

> - **Poku** is designed to be highly intuitive.<br />
> - Compatible with **ESM** and **CJS**, **Node.js** and **TypeScript** (_no-build_).<br />
Expand All @@ -11,6 +11,36 @@
---

## 🧑🏻‍🔧 In progress
## In progress

- Soon releasing version `1.x`.
🧑🏻‍🔧 Soon releasing version `1.x`.

---

## Install

```bash
npm install --save-dev poku
```

---

## Usage

```ts
import { poku } from 'poku';

await poku(['./test/unit/']);

// 🧑🏻‍🔧 Soon documenting all options and Poku's usage variations.
```

---

## TypeScript

To run your tests without compile, just install `tsx` and it's done:

```bash
npm install --save-dev tsx
```
3 changes: 2 additions & 1 deletion tsconfig.test.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
"include": ["test"],
"exclude": ["src"],
"compilerOptions": {
"outDir": "ci"
"outDir": "ci",
"declaration": false
}
}

0 comments on commit 0420a3b

Please sign in to comment.