From 630e537726e2e2dec378ff91da4e5e0970944a60 Mon Sep 17 00:00:00 2001 From: Michael Miller Date: Sat, 18 Aug 2018 15:33:20 -0600 Subject: [PATCH] Initial commit --- .editorconfig | 9 +++++++++ .gitignore | 9 +++++++++ LICENSE | 21 +++++++++++++++++++++ README.md | 43 ++++++++++++++++++++++++++++++++++++++++++ shard.yml | 9 +++++++++ spec/spec_helper.cr | 2 ++ spec/spectator_spec.cr | 9 +++++++++ src/spectator.cr | 6 ++++++ 8 files changed, 108 insertions(+) create mode 100644 .editorconfig create mode 100644 .gitignore 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/spectator_spec.cr create mode 100644 src/spectator.cr diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..163eb75 --- /dev/null +++ b/.editorconfig @@ -0,0 +1,9 @@ +root = true + +[*.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..e29dae7 --- /dev/null +++ b/.gitignore @@ -0,0 +1,9 @@ +/docs/ +/lib/ +/bin/ +/.shards/ +*.dwarf + +# Libraries don't need dependency lock +# Dependencies will be locked in application that uses them +/shard.lock diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..e4174f9 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +The MIT License (MIT) + +Copyright (c) 2018 Michael Miller + +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..c84fe03 --- /dev/null +++ b/README.md @@ -0,0 +1,43 @@ +Spectator +========= + +TODO: Write a description here + +Installation +------------ + +Add this to your application's `shard.yml`: + +```yaml +dependencies: + spectator: + gitlab: arctic-fox/spectator +``` + +Usage +----- + +```crystal +require "spectator" +``` + +TODO: Write usage instructions here + +Development +----------- + +TODO: Write development instructions here + +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 Merge Request + +Contributors +------------ + +- [arctic-fox](https://gitlab.com/arctic-fox) Michael Miller - creator, maintainer diff --git a/shard.yml b/shard.yml new file mode 100644 index 0000000..e45a860 --- /dev/null +++ b/shard.yml @@ -0,0 +1,9 @@ +name: spectator +version: 0.1.0 + +authors: + - Michael Miller + +crystal: 0.26.0 + +license: MIT diff --git a/spec/spec_helper.cr b/spec/spec_helper.cr new file mode 100644 index 0000000..e0c29df --- /dev/null +++ b/spec/spec_helper.cr @@ -0,0 +1,2 @@ +require "spec" +require "../src/spectator" diff --git a/spec/spectator_spec.cr b/spec/spectator_spec.cr new file mode 100644 index 0000000..67b53a7 --- /dev/null +++ b/spec/spectator_spec.cr @@ -0,0 +1,9 @@ +require "./spec_helper" + +describe Spectator do + # TODO: Write tests + + it "works" do + false.should eq(true) + end +end diff --git a/src/spectator.cr b/src/spectator.cr new file mode 100644 index 0000000..3f941c0 --- /dev/null +++ b/src/spectator.cr @@ -0,0 +1,6 @@ +# TODO: Write documentation for `Spectator` +module Spectator + VERSION = "0.1.0" + + # TODO: Put your code here +end