Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update README and package.json #30

Merged
merged 2 commits into from
Apr 8, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
70 changes: 59 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -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)
<p align="center">
<img src="assets/cable-ready-logo-with-copy.svg" width="360" />
<h1 align="center">CableReady</h1>
<p align="center">
<img src="https://img.shields.io/gem/v/cable_ready.svg?color=red" />
<img src="https://img.shields.io/npm/v/cable_ready.svg?color=blue" />
<a href="https://www.npmjs.com/package/cable_ready">
<img alt="downloads" src="https://img.shields.io/npm/dm/cable_ready.svg?color=blue" target="_blank" />
</a>
<a href="https://github.com/hopsoft/cable_ready/blob/master/LICENSE">
<img alt="License: MIT" src="https://img.shields.io/badge/license-MIT-brightgreen.svg" target="_blank" />
</a>
<a href="http://blog.codinghorror.com/the-best-code-is-no-code-at-all/" target="_blank">
<img alt="Lines of Code" src="https://img.shields.io/badge/lines_of_code-267-brightgreen.svg?style=flat" />
</a>
<a href="https://cableready.stimulusreflex.com" target="_blank">
<img alt="Documentation" src="https://img.shields.io/badge/documentation-yes-brightgreen.svg" />
</a>
<br />
<a href="#badge">
<img alt="semantic-release" src="https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg">
</a>
<a href="https://github.com/testdouble/standard" target="_blank">
<img alt="Ruby Code Style" src="https://img.shields.io/badge/Ruby_Code_Style-standard-brightgreen.svg" />
</a>
<a href="https://github.com/sheerun/prettier-standard" target="_blank">
<img alt="JavaScript Code Style" src="https://img.shields.io/badge/JavaScript_Code_Style-prettier_standard-ff69b4.svg" />
</a>
<br />
<a href="https://codeclimate.com/github/hopsoft/cable_ready/maintainability" target="_blank">
<img alt="Maintainability" src="https://api.codeclimate.com/v1/badges/83ddf1fee4af7e51a681/maintainability" />
</a>
<a target="_blank" rel="noopener noreferrer" href="https://github.com/hopsoft/cable_ready/workflows/Prettier-Standard/badge.svg">
<img src="https://github.com/hopsoft/cable_ready/workflows/Prettier-Standard/badge.svg" alt="Prettier-Standard" style="max-width:100%;">
</a>
<a target="_blank" rel="noopener noreferrer" href="https://github.com/hopsoft/cable_ready/workflows/StandardRB/badge.svg">
<img src="https://github.com/hopsoft/cable_ready/workflows/StandardRB/badge.svg" alt="StandardRB" style="max-width:100%;">
</a>
</p>
</p>
<br />

# 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

Expand All @@ -28,14 +76,14 @@ 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`
1. Run `rake release`
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).
24 changes: 20 additions & 4 deletions javascript/package.json
Original file line number Diff line number Diff line change
@@ -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 <natehop@gmail.com>",
"main": "./cable_ready.js",
"scripts": {
"prettier-standard-check": "yarn run prettier-standard --check ./cable_ready.js"
},
"dependencies": {
"morphdom": "^2.5.12"
},
Expand Down