Initial Commit

This commit is contained in:
Danila Fedorin 2018-01-12 15:19:20 -08:00
commit 76381e004a
10 changed files with 102 additions and 0 deletions

7
.editorconfig Normal file
View File

@ -0,0 +1,7 @@
[*.cr]
charset = utf-8
end_of_line = lf
insert_final_newline = true
indent_style = space
indent_size = 2
trim_trailing_whitespace = true

8
.gitignore vendored Normal file
View File

@ -0,0 +1,8 @@
/doc/
/lib/
/bin/
/.shards/
# Libraries don't need dependency lock
# Dependencies will be locked in application that uses them
/shard.lock

1
.travis.yml Normal file
View File

@ -0,0 +1 @@
language: crystal

21
LICENSE Normal file
View File

@ -0,0 +1,21 @@
The MIT License (MIT)
Copyright (c) 2018 Danila Fedorin
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.

37
README.md Normal file
View File

@ -0,0 +1,37 @@
# telepathy
TODO: Write a description here
## Installation
Add this to your application's `shard.yml`:
```yaml
dependencies:
telepathy:
github: [your-github-name]/telepathy
```
## Usage
```crystal
require "telepathy"
```
TODO: Write usage instructions here
## Development
TODO: Write development instructions here
## Contributing
1. Fork it ( https://github.com/[your-github-name]/telepathy/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 a new Pull Request
## Contributors
- [[your-github-name]](https://github.com/[your-github-name]) Danila Fedorin - creator, maintainer

9
shard.yml Normal file
View File

@ -0,0 +1,9 @@
name: telepathy
version: 0.1.0
authors:
- Danila Fedorin <danila.fedorin@gmail.com>
crystal: 0.23.1
license: MIT

2
spec/spec_helper.cr Normal file
View File

@ -0,0 +1,2 @@
require "spec"
require "../src/telepathy"

9
spec/telepathy_spec.cr Normal file
View File

@ -0,0 +1,9 @@
require "./spec_helper"
describe Telepathy do
# TODO: Write tests
it "works" do
false.should eq(true)
end
end

5
src/telepathy.cr Normal file
View File

@ -0,0 +1,5 @@
require "./telepathy/*"
module Telepathy
# TODO Put your code here
end

3
src/telepathy/version.cr Normal file
View File

@ -0,0 +1,3 @@
module Telepathy
VERSION = "0.1.0"
end