diff --git a/README.md b/README.md
index 33748c32..4eee9751 100644
--- a/README.md
+++ b/README.md
@@ -1,21 +1,69 @@
-[![Lines of Code](http://img.shields.io/badge/lines_of_code-267-brightgreen.svg?style=flat)](http://blog.codinghorror.com/the-best-code-is-no-code-at-all/)
-[![Maintainability](https://api.codeclimate.com/v1/badges/83ddf1fee4af7e51a681/maintainability)](https://codeclimate.com/github/hopsoft/cable_ready/maintainability)
-![Prettier-Standard](https://github.com/hopsoft/cable_ready/workflows/Prettier-Standard/badge.svg)
-![StandardRB](https://github.com/hopsoft/cable_ready/workflows/StandardRB/badge.svg)
+
+
+
CableReady
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-# CableReady
-
-CableReady helps you create great real-time user experiences by making it simple to trigger client-side DOM changes from server-side Ruby. It establishes a standard for interacting with the client via ActionCable web sockets. No need for custom JavaScript.
+CableReady helps you create great real-time user experiences by making it simple to trigger client-side DOM changes from server-side Ruby. It establishes a standard for interacting with the client via ActionCable web sockets. No need for custom JavaScript.
Please read the official [ActionCable docs](http://guides.rubyonrails.org/action_cable_overview.html)
to learn more about ActionCable before proceeding.
-## Docs
+## 📚 Docs
- [Official Documentation](https://cableready.stimulusreflex.com)
- [Documentation Source Code](https://github.com/hopsoft/cable_ready/tree/master/docs)
-## Contributing
+## 💙 Community
+
+- [Discord](https://discord.gg/XveN625) - chat root
+
+## 🚀 Install
+
+```sh
+bundle add cable_ready && yarn add cable_ready
+```
+
+Checkout the [documentation](https://cableready.stimulusreflex.com) to continue!
+
+
+## 🙏 Contributing
### Code of Conduct
@@ -28,7 +76,7 @@ and [prettier-standard](https://github.com/sheerun/prettier-standard) to minimiz
Please run `./bin/standardize` prior submitting pull requests.
-### Releasing
+### 📦 Releasing
1. Bump version number at `lib/cable_ready/version.rb`
1. Run `rake build`
@@ -36,6 +84,6 @@ Please run `./bin/standardize` prior submitting pull requests.
1. Change directories `cd ./javascript`
1. Run `yarn publish` - NOTE: this will throw a fatal error because the tag already exists but the package will still publish
-## License
+## 📝 License
CableReady is released under the [MIT License](LICENSE.txt).
diff --git a/javascript/package.json b/javascript/package.json
index f4ce33a1..74516a8e 100644
--- a/javascript/package.json
+++ b/javascript/package.json
@@ -1,16 +1,32 @@
{
"name": "cable_ready",
"version": "4.1.0",
- "main": "./cable_ready.js",
- "scripts": {
- "prettier-standard-check": "yarn run prettier-standard --check ./cable_ready.js"
+ "description": "CableReady helps you create great real-time user experiences by making it simple to trigger client-side DOM changes from server-side Ruby.",
+ "keywords": [
+ "ruby",
+ "rails",
+ "websockets",
+ "actioncable",
+ "cable",
+ "ssr",
+ "stimulus_reflex",
+ "client-side",
+ "dom"
+ ],
+ "homepage": "https://cableready.stimulusreflex.com/",
+ "bugs": {
+ "url": "https://github.com/hopsoft/cable_ready/issues"
},
"repository": {
"type": "git",
"url": "git+https://github.com:hopsoft/cable_ready.git"
},
- "author": "Nathan Hopkins",
"license": "MIT",
+ "author": "Nathan Hopkins ",
+ "main": "./cable_ready.js",
+ "scripts": {
+ "prettier-standard-check": "yarn run prettier-standard --check ./cable_ready.js"
+ },
"dependencies": {
"morphdom": "^2.5.12"
},