From cda1abfecc015b7f03e00411afdf5369ecea65ad Mon Sep 17 00:00:00 2001
From: Daniel Roe <daniel@roe.dev>
Date: Mon, 19 Dec 2022 13:57:08 +0000
Subject: [PATCH] chore: add README

---
 LICENCE   | 21 +++++++++++++++++++++
 README.md | 54 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 75 insertions(+)
 create mode 100644 LICENCE
 create mode 100644 README.md

diff --git a/LICENCE b/LICENCE
new file mode 100644
index 0000000..7d7d281
--- /dev/null
+++ b/LICENCE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Daniel Roe
+
+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.
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..66bb624
--- /dev/null
+++ b/README.md
@@ -0,0 +1,54 @@
+<h1 align="center">vitest-environment-nuxt</h1>
+<p align="center">An in-development vitest environment with support for testing code that needs a Nuxt runtime environment.</p>
+
+<p align="center">
+
+[![npm version][npm-version-src]][npm-version-href]
+[![npm downloads][npm-downloads-src]][npm-downloads-href]
+[![Github Actions][github-actions-src]][github-actions-href]
+[![Codecov][codecov-src]][codecov-href]
+
+</p>
+
+> An in-development vitest environment with support for testing code that needs a Nuxt runtime environment
+
+⚠️ This library is in active development and you should pin the patch version before using.
+
+## Quick Start
+
+First install `vitest-environment-nuxt`:
+
+```bash
+yarn add --dev vitest-environment-nuxt
+
+# or npm
+npm i -D vitest-environment-nuxt
+
+# or pnpm
+pnpm add -D vitest-environment-nuxt
+```
+
+## 💻 Development
+
+- Clone this repository
+- Enable [Corepack](https://github.com/nodejs/corepack) using `corepack enable` (use `npm i -g corepack` for Node.js < 16.10)
+- Install dependencies using `pnpm install`
+- Stub the library using `pnpm dev:prepare`
+- Run interactive tests using `pnpm test`
+
+## License
+
+Made with ❤️
+
+Published under [MIT License](./LICENCE).
+
+<!-- Badges -->
+
+[npm-version-src]: https://img.shields.io/npm/v/vitest-environment-nuxt?style=flat-square
+[npm-version-href]: https://npmjs.com/package/vitest-environment-nuxt
+[npm-downloads-src]: https://img.shields.io/npm/dm/vitest-environment-nuxt?style=flat-square
+[npm-downloads-href]: https://npmjs.com/package/vitest-environment-nuxt
+[github-actions-src]: https://img.shields.io/github/workflow/status/danielroe/vitest-environment-nuxt/ci/main?style=flat-square
+[github-actions-href]: https://github.com/danielroe/vitest-environment-nuxt/actions?query=workflow%3Aci
+[codecov-src]: https://img.shields.io/codecov/c/gh/danielroe/vitest-environment-nuxt/main?style=flat-square
+[codecov-href]: https://codecov.io/gh/danielroe/vitest-environment-nuxt
-- 
knotmirror 0.0.1