fix: Initial release (#1)

Co-authored-by: Zack Stevens <[email protected]>

README.md

@@ -1,8 +1,33 @@
-# release-config-template
-semantic-release release configuration template repository
-
-# How do I use it?
-1. modify `index.js` to export whatever release config you want, this is the shareable config that other releases will use.
-2. Replace all instances of `release-config-template` with the name of your release config. It should follow the convention `release-config-{your name here}`
-3. PR to main following conventional commits. Make sure your squash message follows conventional commits.
-4. The release workflow should run, and publish your shareable config to npm so you can use it in releases via extends as `@unsupervised/release-config-{your name here}`
+# release-config-general
+A semantic-release sharable configuration for releasing general code. This is a fairly standard configuration with no exec plugins, and no npm plugin.
+This release config generats release notes, a changelog, commits the changelog via the git plugin, and releases to github.
+## Plugins
+
+This shareable configuration use the following plugins:
+
+- [`@semantic-release/commit-analyzer`](https://github.com/semantic-release/commit-analyzer)
+- [`@semantic-release/release-notes-generator`](https://github.com/semantic-release/release-notes-generator)
+- [`@semantic-release/changelog`](https://github.com/semantic-release/changelog)
+- [`@semantic-release/git`](https://github.com/semantic-release/git)
+- [`@semantic-release/github`](https://github.com/semantic-release/github)
+
+## Install
+
+```bash
+$ npm install --save-dev semantic-release @unsupervised/release-config-general
+```
+
+## Usage
+
+The shareable config can be configured in the [**semantic-release** configuration file](https://github.com/semantic-release/semantic-release/blob/master/docs/usage/configuration.md#configuration):
+
+```json
+{
+  "extends": "@unsupervised/release-config-general"
+}
+```
+
+## Configuration
+
+See each [plugin](#plugins) documentation for required installation and configuration steps.
+

package.json

@@ -1,5 +1,5 @@
 {
-  "name": "@unsupervised/release-config-template",
+  "name": "@unsupervised/release-config-general",
   "version": "1.0.0",
   "description": "semantic-release shareable config template repsitory",
   "main": "index.js",
@@ -8,14 +8,14 @@
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/Unsupervisedcom/release-config-template.git"
+    "url": "git+https://github.com/Unsupervisedcom/release-config-general.git"
   },
   "author": "Unsupervised",
   "license": "UNLICENSED",
   "bugs": {
-    "url": "https://github.com/Unsupervisedcom/release-config-template/issues"
+    "url": "https://github.com/Unsupervisedcom/release-config-general/issues"
   },
-  "homepage": "https://github.com/Unsupervisedcom/release-config-template#readme",
+  "homepage": "https://github.com/Unsupervisedcom/release-config-general#readme",
   "dependencies": {
     "@semantic-release/changelog": "^6.0.1",
     "@semantic-release/commit-analyzer": "^9.0.2",