Merge pull request #92 from bugsnag/add-readme-files

Add readme files to all packages
bugsnag · Apr 21, 2021 · 2bace5b · 2bace5b
2 parents cf2218c + ae6c5cd
commit 2bace5b
Show file tree

Hide file tree

Showing 21 changed files with 132 additions and 2 deletions.
diff --git a/packages/delivery-electron/README.md b/packages/delivery-electron/README.md
@@ -0,0 +1,7 @@
+# @bugsnag/delivery-electron
+
+@bugsnag/electron delivery mechanism to send events, sessions, and crash dumps from Electron apps
+
+## License
+
+This package is free software released under the MIT License. See [LICENSE.txt](./LICENSE.txt) for details.
diff --git a/packages/electron-filestore/README.md b/packages/electron-filestore/README.md
@@ -0,0 +1,7 @@
+# @bugsnag/electron-filestore
+
+@bugsnag/electron package for storing events, sessions and crash dumps on the file system
+
+## License
+
+This package is free software released under the MIT License. See [LICENSE.txt](./LICENSE.txt) for details.
diff --git a/packages/electron-filestore/package.json b/packages/electron-filestore/package.json
@@ -2,7 +2,7 @@
   "name": "@bugsnag/electron-filestore",
   "version": "1.0.0",
   "main": "filestore.js",
-  "description": "@bugsnag/electron plugin to add process info to events",
+  "description": "@bugsnag/electron package for storing events, sessions and crash dumps on the file system",
   "author": "Bugsnag",
   "license": "MIT",
   "homepage": "https://www.bugsnag.com/",

diff --git a/packages/electron-test-helpers/README.md b/packages/electron-test-helpers/README.md
@@ -0,0 +1,7 @@
+# @bugsnag/electron-test-helpers
+
+Test helpers for @bugsnag/electron
+
+## License
+
+This package is free software released under the MIT License. See [LICENSE.txt](./LICENSE.txt) for details.
diff --git a/packages/electron/README.md b/packages/electron/README.md
@@ -0,0 +1,7 @@
+# @bugsnag/electron
+
+This package contains the Electron implementation of the Bugsnag notifier for JavaScript.
+
+## License
+
+This package is free software released under the MIT License. See [LICENSE.txt](./LICENSE.txt) for details.
diff --git a/packages/plugin-electron-app-breadcrumbs/README.md b/packages/plugin-electron-app-breadcrumbs/README.md
@@ -0,0 +1,7 @@
+# @bugsnag/plugin-electron-app-breadcrumbs
+
+@bugsnag/electron plugin to collect breadcrumbs for app lifecycle events
+
+## License
+
+This package is free software released under the MIT License. See [LICENSE.txt](./LICENSE.txt) for details.
diff --git a/packages/plugin-electron-app/README.md b/packages/plugin-electron-app/README.md
@@ -0,0 +1,7 @@
+# @bugsnag/plugin-electron-app
+
+@bugsnag/electron plugin to collect app information
+
+## License
+
+This package is free software released under the MIT License. See [LICENSE.txt](./LICENSE.txt) for details.
diff --git a/packages/plugin-electron-client-state-manager/README.md b/packages/plugin-electron-client-state-manager/README.md
@@ -12,3 +12,7 @@ The plugin runs in the main Electron process, and patches each of the client mut
 Any call to these methods (which will be from a developer or a plugin calling `Bugsnag.<method>()` in the main process) will emit an event signifying the change and updated value.
 
 Separately, we expose a `bulkUpdate` method for a new renderer to deliver a full state update in one pass.
+
+## License
+
+This package is free software released under the MIT License. See [LICENSE.txt](./LICENSE.txt) for details.
diff --git a/packages/plugin-electron-client-state-persistence/README.md b/packages/plugin-electron-client-state-persistence/README.md
@@ -0,0 +1,7 @@
+# @bugsnag/plugin-electron-client-state-persistence
+
+@bugsnag/electron plugin to sync information between JS and native layer
+
+## License
+
+This package is free software released under the MIT License. See [LICENSE.txt](./LICENSE.txt) for details.
diff --git a/packages/plugin-electron-device/README.md b/packages/plugin-electron-device/README.md
@@ -0,0 +1,7 @@
+# @bugsnag/plugin-electron-device
+
+@bugsnag/electron plugin to collect device information
+
+## License
+
+This package is free software released under the MIT License. See [LICENSE.txt](./LICENSE.txt) for details.
diff --git a/packages/plugin-electron-net-breadcrumbs/README.md b/packages/plugin-electron-net-breadcrumbs/README.md
@@ -0,0 +1,7 @@
+# @bugsnag/plugin-electron-net-breadcrumbs
+
+@bugsnag/electron plugin to collect breadcrumbs from requests made with the net module
+
+## License
+
+This package is free software released under the MIT License. See [LICENSE.txt](./LICENSE.txt) for details.
diff --git a/packages/plugin-electron-network-status/README.md b/packages/plugin-electron-network-status/README.md
@@ -0,0 +1,7 @@
+# @bugsnag/plugin-electron-network-status
+
+@bugsnag/electron plugin to monitor the network status
+
+## License
+
+This package is free software released under the MIT License. See [LICENSE.txt](./LICENSE.txt) for details.
diff --git a/packages/plugin-electron-power-monitor-breadcrumbs/README.md b/packages/plugin-electron-power-monitor-breadcrumbs/README.md
@@ -0,0 +1,7 @@
+# @bugsnag/plugin-electron-power-monitor-breadcrumbs
+
+@bugsnag/electron plugin to collect power state breadcrumbs
+
+## License
+
+This package is free software released under the MIT License. See [LICENSE.txt](./LICENSE.txt) for details.
diff --git a/packages/plugin-electron-preload-error/README.md b/packages/plugin-electron-preload-error/README.md
@@ -0,0 +1,7 @@
+# @bugsnag/plugin-electron-preload-error
+
+@bugsnag/electron plugin to handle errors in preload scripts
+
+## License
+
+This package is free software released under the MIT License. See [LICENSE.txt](./LICENSE.txt) for details.
diff --git a/packages/plugin-electron-process-info/README.md b/packages/plugin-electron-process-info/README.md
@@ -0,0 +1,7 @@
+# @bugsnag/plugin-electron-process-info
+
+@bugsnag/electron plugin to collect process information for errors
+
+## License
+
+This package is free software released under the MIT License. See [LICENSE.txt](./LICENSE.txt) for details.
diff --git a/packages/plugin-electron-renderer-event-data/README.md b/packages/plugin-electron-renderer-event-data/README.md
@@ -0,0 +1,7 @@
+# @bugsnag/plugin-electron-renderer-event-data
+
+@bugsnag/electron plugin to get fully populated event data in renderer callbacks
+
+## License
+
+This package is free software released under the MIT License. See [LICENSE.txt](./LICENSE.txt) for details.
diff --git a/packages/plugin-electron-renderer-event-data/package.json b/packages/plugin-electron-renderer-event-data/package.json
@@ -2,7 +2,7 @@
   "name": "@bugsnag/plugin-electron-renderer-event-data",
   "version": "1.0.0",
   "main": "renderer-event-data.js",
-  "description": "@bugsnag/electron plugin to get event fully populated event data in renderer callbacks",
+  "description": "@bugsnag/electron plugin to get fully populated event data in renderer callbacks",
   "homepage": "https://www.bugsnag.com/",
   "repository": {
     "type": "git",

diff --git a/packages/plugin-electron-renderer-strip-project-root/README.md b/packages/plugin-electron-renderer-strip-project-root/README.md
@@ -0,0 +1,7 @@
+# @bugsnag/plugin-electron-renderer-strip-project-root
+
+@bugsnag/electron plugin to strip the project root from stack traces
+
+## License
+
+This package is free software released under the MIT License. See [LICENSE.txt](./LICENSE.txt) for details.
diff --git a/packages/plugin-electron-screen-breadcrumbs/README.md b/packages/plugin-electron-screen-breadcrumbs/README.md
@@ -0,0 +1,7 @@
+# @bugsnag/plugin-electron-screen-breadcrumbs
+
+@bugsnag/electron plugin to collect screen breadcrumbs
+
+## License
+
+This package is free software released under the MIT License. See [LICENSE.txt](./LICENSE.txt) for details.
diff --git a/packages/plugin-electron-session/README.md b/packages/plugin-electron-session/README.md
@@ -0,0 +1,7 @@
+# @bugsnag/plugin-electron-session
+
+@bugsnag/electron plugin for sessions
+
+## License
+
+This package is free software released under the MIT License. See [LICENSE.txt](./LICENSE.txt) for details.
diff --git a/packages/plugin-internal-callback-marker/README.md b/packages/plugin-internal-callback-marker/README.md
@@ -0,0 +1,7 @@
+# @bugsnag/plugin-internal-callback-marker
+
+@bugsnag/js plugin to annotate all OnError callbacks added by internal plugins
+
+## License
+
+This package is free software released under the MIT License. See [LICENSE.txt](./LICENSE.txt) for details.