https://github.com/quantum-elixir/quantum-swarm
:globe_with_meridians: Swarm Adapter for Quantum
https://github.com/quantum-elixir/quantum-swarm
Last synced: about 1 year ago
JSON representation
:globe_with_meridians: Swarm Adapter for Quantum
- Host: GitHub
- URL: https://github.com/quantum-elixir/quantum-swarm
- Owner: quantum-elixir
- License: apache-2.0
- Created: 2020-08-04T15:19:47.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2024-09-03T20:57:34.000Z (over 1 year ago)
- Last Synced: 2024-10-29T22:37:19.527Z (over 1 year ago)
- Language: Elixir
- Size: 17.6 KB
- Stars: 4
- Watchers: 3
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# QuantumSwarm
[](https://opencollective.com/quantum)
[](https://hex.pm/packages/quantum_swarm)
[](https://hexdocs.pm/quantum_swarm)
[](https://coveralls.io/r/quantum-elixir/quantum-swarm?branch=master)
[](https://hex.pm/packages/quantum_swarm)
> **This README follows master, which may not be the currently published version**. Here are the
[docs for the latest published version of Quantum Swarm](https://hexdocs.pm/quantum_swarm/readme.html).
Very simple [`swarm`](https://hex.pm/packages/swarm) clustering adapter for
[`quantum`](https://hex.pm/packages/quantum).
:warning: :warning: **This adapter does not support process handoff. Therefore it is vital that a persistent storage is used.**
## Installation
The package can be installed by adding `quantum_swarm` to your list of dependencies
in `mix.exs`:
```elixir
def deps do
[
{:quantum_swarm, "~> 1.0"}
]
end
```
Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc)
and published on [HexDocs](https://hexdocs.pm). The docs can be found at
[https://hexdocs.pm/quantum_swarm](https://hexdocs.pm/quantum_swarm).
## Contribution
This project uses the [Collective Code Construction Contract (C4)](http://rfc.zeromq.org/spec:42/C4/) for all code changes.
> "Everyone, without distinction or discrimination, SHALL have an equal right to become a Contributor under the
terms of this contract."
### tl;dr
1. Check for [open issues](https://github.com/quantum-elixir/quantum-swarm/issues) or [open a new issue](https://github.com/quantum-elixir/quantum-swarm/issues/new) to start a discussion around [a problem](https://www.youtube.com/watch?v=_QF9sFJGJuc).
2. Issues SHALL be named as "Problem: _description of the problem_".
3. Fork the [quantum-swarm repository on GitHub](https://github.com/quantum-elixir/quantum-swarm) to start making your changes
4. If possible, write a test which shows that the problem was solved.
5. Send a pull request.
6. Pull requests SHALL be named as "Solution: _description of your solution_"
7. Your pull request is merged and you are added to the [list of contributors](https://github.com/quantum-elixir/quantum-swarm/graphs/contributors)
### Code Contributors
This project exists thanks to all the people who contribute.
### Financial Contributors
Become a financial contributor and help us sustain our community. [[Contribute](https://opencollective.com/quantum/contribute)]
#### Individuals
#### Organizations
Support this project with your organization. Your logo will show up here with a link to your website. [[Contribute](https://opencollective.com/quantum/contribute)]
## License
[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0)