fix(docs): added missing README files

serenity-js · Dec 16, 2020 · aa3f63b · aa3f63b
1 parent f6c8a78
commit aa3f63b
Show file tree

Hide file tree

Showing 8 changed files with 39 additions and 4 deletions.
diff --git a/projects/todo-app-api/README.md b/projects/todo-app-api/README.md
@@ -0,0 +1,7 @@
+# Serenity/JS
+
+[Serenity/JS](https://serenity-js.org) is a Node.js framework designed to make acceptance and regression testing of modern full-stack applications faster, more collaborative and easier to scale.
+
+## Serenity/JS Todo App
+
+This module contains a REST API used by [Serenity/JS Todo App](https://github.com/serenity-js/todo-app).
diff --git a/projects/todo-app-api/package.json b/projects/todo-app-api/package.json
@@ -8,7 +8,8 @@
     "dist",
     "CHANGELOG.md",
     "LICENSE.md",
-    "NOTICE.md"
+    "NOTICE.md",
+    "README.md"
   ],
   "funding": {
     "url": "https://github.com/sponsors/serenity-js"

diff --git a/projects/todo-app-domain/README.md b/projects/todo-app-domain/README.md
@@ -0,0 +1,7 @@
+# Serenity/JS
+
+[Serenity/JS](https://serenity-js.org) is a Node.js framework designed to make acceptance and regression testing of modern full-stack applications faster, more collaborative and easier to scale.
+
+## Serenity/JS Todo App
+
+This module contains domain models used by [Serenity/JS Todo App](https://github.com/serenity-js/todo-app).
diff --git a/projects/todo-app-domain/package.json b/projects/todo-app-domain/package.json
@@ -8,7 +8,8 @@
     "dist",
     "CHANGELOG.md",
     "LICENSE.md",
-    "NOTICE.md"
+    "NOTICE.md",
+    "README.md"
   ],
   "funding": {
     "url": "https://github.com/sponsors/serenity-js"

diff --git a/projects/todo-app-ui/README.md b/projects/todo-app-ui/README.md
@@ -0,0 +1,7 @@
+# Serenity/JS
+
+[Serenity/JS](https://serenity-js.org) is a Node.js framework designed to make acceptance and regression testing of modern full-stack applications faster, more collaborative and easier to scale.
+
+## Serenity/JS Todo App
+
+This module contains an Angular-based user interface used by [Serenity/JS Todo App](https://github.com/serenity-js/todo-app).
diff --git a/projects/todo-app-ui/package.json b/projects/todo-app-ui/package.json
@@ -7,7 +7,8 @@
     "dist",
     "CHANGELOG.md",
     "LICENSE.md",
-    "NOTICE.md"
+    "NOTICE.md",
+    "README.md"
   ],
   "funding": {
     "url": "https://github.com/sponsors/serenity-js"

diff --git a/projects/todo-app/README.md b/projects/todo-app/README.md
@@ -0,0 +1,7 @@
+# Serenity/JS
+
+[Serenity/JS](https://serenity-js.org) is a Node.js framework designed to make acceptance and regression testing of modern full-stack applications faster, more collaborative and easier to scale.
+
+## Serenity/JS Todo App
+
+[Serenity/JS Todo App](https://github.com/serenity-js/todo-app) is a simple full-stack system you can use to hone your test automation skills.
diff --git a/projects/todo-app/package.json b/projects/todo-app/package.json
@@ -4,12 +4,16 @@
   "description": "Serenity/JS Todo App",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
+  "bin": {
+    "todo-app": "bin/todo-app"
+  },
   "files": [
     "bin",
     "dist",
     "CHANGELOG.md",
     "LICENSE.md",
-    "NOTICE.md"
+    "NOTICE.md",
+    "README.md"
   ],
   "funding": {
     "url": "https://github.com/sponsors/serenity-js"