From 3edab111158ea41496451e0e13d301d33ec367af Mon Sep 17 00:00:00 2001
From: epszaw <konstantin@epishev.me>
Date: Thu, 17 Aug 2023 18:02:18 +0200
Subject: [PATCH] update docs for jest and jasmine

---
 packages/allure-jasmine/README.md | 42 +++++++++++++++++++++++++++++++
 packages/allure-jest/README.md    |  4 ++-
 2 files changed, 45 insertions(+), 1 deletion(-)

diff --git a/packages/allure-jasmine/README.md b/packages/allure-jasmine/README.md
index 806d0e47d..9dd1e7b0c 100644
--- a/packages/allure-jasmine/README.md
+++ b/packages/allure-jasmine/README.md
@@ -3,3 +3,45 @@
 Allure integration Jasmine framework
 
 For usage example see `test/Setup.ts`
+
+## Usage with Jest (`jest@<27`)
+
+> If you're looking for `jest-circus` integration (`jest@27.x.x`) you need to
+> use [`allure-jest` package][allure-jest] instead.
+
+Use your favorite node package manager to install required packages:
+
+```bash
+npm i -D jest-jasmine2 allure-jasmine allure-js-commons @types/jasmine
+```
+
+Create `allure-setup.ts` file:
+
+```ts
+import { JasmineAllureReporter } from "allure-jasmine";
+import { JasmineAllureInterface } from "allure-jasmine/dist/src/JasmineAllureReporter";
+
+const reporter = new JasmineAllureReporter({ resultsDir: "allure-results" });
+
+jasmine.getEnv().addReporter(reporter);
+// @ts-expect-error
+global.allure = reporter.getInterface();
+
+declare global {
+  const allure: JasmineAllureInterface;
+}
+```
+
+Change your `jest.config.js` file:
+
+```js
+module.exports = {
+  preset: "ts-jest",
++  testRunner: "jest-jasmine2",
++  setupFilesAfterEnv: ["./allure-setup.ts"],
+};
+```
+
+You can find example setup and usage in this [repo](https://github.com/vovsemenv/allure-jest-example)
+
+[allure-jest]: https://github.com/allure-framework/allure-js/tree/master/packages/allure-jest
diff --git a/packages/allure-jest/README.md b/packages/allure-jest/README.md
index a36a729b4..9f2bf03b3 100644
--- a/packages/allure-jest/README.md
+++ b/packages/allure-jest/README.md
@@ -4,7 +4,7 @@ Allure integration for `jest@^27.x.x` (`jest-circus`).
 
 > **Warning**
 > If you're looking for `jest-jasmine` integration (`< 27.x.x`) you need to
-> change default runner to `Jasmine` and use `allure-jasmine` instead.
+> change default runner to `Jasmine` and use [`allure-jasmine` package][allure-jasmine] instead.
 
 ## Installation
 
@@ -41,3 +41,5 @@ it("my test", () => {
   });
 });
 ```
+
+[allure-jasmine]: https://github.com/allure-framework/allure-js/tree/master/packages/allure-jasmine