Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tatums/telegram
A messaging tool
https://github.com/tatums/telegram
Last synced: 3 months ago
JSON representation
A messaging tool
- Host: GitHub
- URL: https://github.com/tatums/telegram
- Owner: tatums
- License: mit
- Created: 2014-02-12T00:49:03.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2015-06-16T04:53:58.000Z (over 9 years ago)
- Last Synced: 2024-05-31T19:59:57.856Z (5 months ago)
- Language: Ruby
- Homepage:
- Size: 277 KB
- Stars: 4
- Watchers: 3
- Forks: 6
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
## Why Telegram?
Daily our development team was sending emails, IMs, and text messages with updates on code changes. What we found was our communication methods were broken. The correct information wasn't in front of us when you needed it. Why is everything but our application telling us about our application? So we created telegram.
Your messages, commited with your code. Didn't get that email? Didn't see that text? Nobody misses a telegram.
* commmunicate with messages
* plan for removing techincal debt
* see history of commuication
## Installation
Add this line to your application's Gemfile:
gem 'telegram', :git => "git://github.com/Homestyle/telegram.git"
And then execute:
$ bundle
Or install it yourself as:
$ gem install telegram
Install config/telegram.yml and other folders
$ telegram install
### Timezone
```
["America/New_York",
"America/Detroit",
"America/Kentucky/Louisville",
"America/Kentucky/Monticello",
"America/Indiana/Indianapolis",
"America/Indiana/Vincennes",
"America/Indiana/Winamac",
"America/Indiana/Marengo",
"America/Indiana/Petersburg",
"America/Indiana/Vevay",
"America/Chicago",
"America/Indiana/Tell_City",
"America/Indiana/Knox",
"America/Menominee",
"America/North_Dakota/Center",
"America/North_Dakota/New_Salem",
"America/North_Dakota/Beulah",
"America/Denver",
"America/Boise",
"America/Phoenix",
"America/Los_Angeles",
"America/Anchorage",
"America/Juneau",
"America/Sitka",
"America/Yakutat",
"America/Nome",
"America/Adak",
"America/Metlakatla",
"Pacific/Honolulu"]
```
## Usage
This gem include a binary - so you can call telegram from the bash
prompt.
### All messages
```ruby
telegram all
```
### Pending Messages
```ruby
telegram pending
```
### Future Messages
```ruby
telegram future
```
### Create a new Message
```ruby
telegram new "This is an important message."
Message created!
```
You can also create a message for the future. A great way to help you
remember to remove technical debt. It takes an arguement as an integer of days.
```ruby
telegram new "This is an important message." -f
Message created!
```
use the console
```ruby
telegram console
1. 03/11/2014 - This is an important message.
2. quit
3. help
Please choose an option..
```
##How does it work?
### Messages
When you create a message a yml file is created in telegram/messages. This file will be
commited to your git repo with your code. When another developer pulls down your code, they will also receive your message file. The next time they use the app. They will need to acknowlege your message before they can continue.
### Acknowledgments
When you acknowlege a message a file is created. This file does not get
commited to the repo. It is important for this file/directory to be .gitignored
## Contributing
1. Fork it ( http://github.com//telegram/fork )
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 new Pull Request