feat: update docs for releases

ajhenry · Sep 28, 2023 · a5ff7f3 · a5ff7f3
1 parent 09bab69
commit a5ff7f3
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 1 deletion.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -16,3 +16,7 @@ yarn dev
 This will setup the project to watch for changes and start a local server at <localhost:3000>.
 
 The React package is found in `packages/prettyavatars` and the website is found in `packages/website`.
+
+## Publishing a Release
+
+Run `yarn release` to publish a new release. Lerna will take care of everything for you.
diff --git a/README.md b/README.md
@@ -76,6 +76,18 @@ import Avatar from 'prettyavatars'
 />
 ```
 
+### smile
+
+<div align="center">
+  <img src="https://prettyavatars.com/api/smile/100?random-name=true"/>
+</div>
+
+#### CDN
+
+```url
+https://prettyavatars.com/api/smile/100
+```
+
 ### pixel-art
 
 Credit goes to [laurentpayot/minidenticons](https://github.com/laurentpayot/minidenticons)

diff --git a/package.json b/package.json
@@ -20,7 +20,8 @@
     "dev": "lerna bootstrap && lerna run --parallel dev",
     "build": "lerna run build",
     "test": "lerna run test",
-    "prepare": "husky install"
+    "prepare": "husky install",
+    "release": "lerna publish"
   },
   "lint-staged": {
     "**/*.{js,jsx,ts,tsx}": [