add readme

OperationSpark · Aug 5, 2024 · 7003203 · 7003203
1 parent f16f490
commit 7003203
Show file tree

Hide file tree

Showing 2 changed files with 39 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1 @@
+.DS_Store
diff --git a/README.md b/README.md
@@ -0,0 +1,38 @@
+# Custom mocha styles
+
+This is a simple package that includes some additional style/functionality to the mocha test runner.
+
+## Include in your project
+
+To include this package in your project, simply add the following to the `<head>` of your html test file
+
+### Styles
+```html
+<link
+  rel="stylesheet"
+  href="https://cdn.jsdelivr.net/gh/OperationSpark/mocha-style@main/mocha.css"
+/>
+```
+### Syntax highlighting
+```html
+  <script src="https://cdn.jsdelivr.net/gh/OperationSpark/mocha-style@main/injectStyles.js"></script>
+```
+
+### Example
+```html
+<!DOCTYPE html>
+<html>
+  <head>
+    ...
+    <link
+      rel="stylesheet"
+      href="https://cdn.jsdelivr.net/gh/OperationSpark/mocha-style@main/mocha.css"
+    />
+
+    <script src="https://cdn.jsdelivr.net/gh/OperationSpark/mocha-style@main/injectStyles.js"></script>
+
+    ...
+  </head>
+  ...
+</html>
+```