https://github.com/grokify/crystal-pingpong
Simple example shard
https://github.com/grokify/crystal-pingpong
Last synced: 9 months ago
JSON representation
Simple example shard
- Host: GitHub
- URL: https://github.com/grokify/crystal-pingpong
- Owner: grokify
- License: mit
- Created: 2022-09-25T23:44:39.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-11-13T12:56:28.000Z (about 2 years ago)
- Last Synced: 2024-10-12T00:49:12.030Z (about 1 year ago)
- Language: Crystal
- Homepage:
- Size: 14.6 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Crystal PingPong Example Shard
[![Build Status][build-status-svg]][build-status-url]
[![License][license-svg]][license-url]
This is a simple, example shard.
It was created with the name `pingpong` and then moved into the repo `github.com/grokify/crystal-pingpong`.
```bash
% crystal init lib pingpong
```
## Installation
1. Add the dependency to your `shard.yml`:
```yaml
dependencies:
pingpong:
github: grokify/crystal-pingpong
```
2. Run `shards install`
## Usage
```crystal
require "pingpong"
pp = Pingpong::Ping.new
puts pp.ping // "pong"
```
## References
1. [Crystal Docs: Writing Shards](https://crystal-lang.org/reference/1.5/guides/writing_shards.html)
1. [Make your own Shard in Crystal language by Vitalii Elenhaupt](https://veelenga.github.io/make-your-own-shard-in-crystal-language/)
1. Referenced shard: [`crystal-memcached`](https://github.com/comandeo/crystal-memcached)
1. Referenced shard: [`twitter-crystal`](https://github.com/mamantoha/twitter-crystal)
## Contributing
1. Fork it ()
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request
[build-status-svg]: https://github.com/grokify/crystal-pingpong/workflows/Crystal%20CI/badge.svg?branch=main
[build-status-url]: https://github.com/grokify/crystal-pingpong/actions
[license-svg]: https://img.shields.io/badge/license-MIT-blue.svg
[license-url]: https://github.com/grokify/crystal-pingpong/blob/master/LICENSE