v0.0.1

.github/workflows/validate.yml

@@ -25,4 +25,4 @@ jobs:
         run: npm ci
 
       - name: Validate
-        run: npm run --workspace=@standard-html/core prepublishOnly
+        run: npm run --workspace=standard-html prepublishOnly

README.md

@@ -2,4 +2,35 @@
 
 _Check if your HTML is compliant with W3C standards_
 
-Still in development.
+## Setup
+
+Install package:
+
+```shell
+$ npm install --save-dev standard-html
+```
+
+## Usage
+
+Usage example using `@testing-library/react` and `vitest`
+
+```
+import { expect, test } from "vitest";
+import { render } from "@testing-library/react";
+import { validateMarkup } from "standard-html";
+
+import App from "./App";
+
+test("markup is valid", async () => {
+  const { container } = render(<App />);
+
+  const [violations, summary] = await validateMarkup(container);
+  expect(violations).toEqual([]);
+  expect(summary.length).toEqual(0);
+});
+
+```
+
+Error output example:
+
+<img src=https://raw.githubusercontent.com/abereghici/standard-html/main/example.png width=800 alt=screenshot>

package.json

@@ -1,5 +1,5 @@
 {
-  "name": "@standard-html/monorepo",
+  "name": "standard-html-monorepo",
   "version": "0.0.0",
   "private": true,
   "description": "Monorepo for standard-html packages",

packages/core/package.json

@@ -1,5 +1,5 @@
 {
-  "name": "@standard-html/core",
+  "name": "standard-html",
   "version": "0.0.1",
   "description": "Check if your HTML is compliant with W3C standards",
   "license": "MIT",