From 76381e004a011f3e327da70766a4fbfba02dc9d5 Mon Sep 17 00:00:00 2001 From: Danila Fedorin Date: Fri, 12 Jan 2018 15:19:20 -0800 Subject: [PATCH] Initial Commit --- .editorconfig | 7 +++++++ .gitignore | 8 ++++++++ .travis.yml | 1 + LICENSE | 21 +++++++++++++++++++++ README.md | 37 +++++++++++++++++++++++++++++++++++++ shard.yml | 9 +++++++++ spec/spec_helper.cr | 2 ++ spec/telepathy_spec.cr | 9 +++++++++ src/telepathy.cr | 5 +++++ src/telepathy/version.cr | 3 +++ 10 files changed, 102 insertions(+) create mode 100644 .editorconfig create mode 100644 .gitignore create mode 100644 .travis.yml create mode 100644 LICENSE create mode 100644 README.md create mode 100644 shard.yml create mode 100644 spec/spec_helper.cr create mode 100644 spec/telepathy_spec.cr create mode 100644 src/telepathy.cr create mode 100644 src/telepathy/version.cr diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..8f0c87a --- /dev/null +++ b/.editorconfig @@ -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 diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..23ec656 --- /dev/null +++ b/.gitignore @@ -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 diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000..ffc7b6a --- /dev/null +++ b/.travis.yml @@ -0,0 +1 @@ +language: crystal diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..e66fb36 --- /dev/null +++ b/LICENSE @@ -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. diff --git a/README.md b/README.md new file mode 100644 index 0000000..e3c1982 --- /dev/null +++ b/README.md @@ -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 diff --git a/shard.yml b/shard.yml new file mode 100644 index 0000000..64dcdd9 --- /dev/null +++ b/shard.yml @@ -0,0 +1,9 @@ +name: telepathy +version: 0.1.0 + +authors: + - Danila Fedorin + +crystal: 0.23.1 + +license: MIT diff --git a/spec/spec_helper.cr b/spec/spec_helper.cr new file mode 100644 index 0000000..248ffb9 --- /dev/null +++ b/spec/spec_helper.cr @@ -0,0 +1,2 @@ +require "spec" +require "../src/telepathy" diff --git a/spec/telepathy_spec.cr b/spec/telepathy_spec.cr new file mode 100644 index 0000000..fb93ffb --- /dev/null +++ b/spec/telepathy_spec.cr @@ -0,0 +1,9 @@ +require "./spec_helper" + +describe Telepathy do + # TODO: Write tests + + it "works" do + false.should eq(true) + end +end diff --git a/src/telepathy.cr b/src/telepathy.cr new file mode 100644 index 0000000..b0427cf --- /dev/null +++ b/src/telepathy.cr @@ -0,0 +1,5 @@ +require "./telepathy/*" + +module Telepathy + # TODO Put your code here +end diff --git a/src/telepathy/version.cr b/src/telepathy/version.cr new file mode 100644 index 0000000..d23bbc5 --- /dev/null +++ b/src/telepathy/version.cr @@ -0,0 +1,3 @@ +module Telepathy + VERSION = "0.1.0" +end