Scaffold component

LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2020 CREATOR_NAME
+Copyright (c) 2020 George Dietrich
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,62 +1,35 @@
-# README
+# Console
 
-Template repo for creating a new Athena component. Scaffolds the Crystal shard's structure as well as define CI etc.
+[![CI](https://github.com/athena-framework/console/workflows/CI/badge.svg)](https://github.com/athena-framework/console/actions?query=workflow%3ACI)
+[![Latest release](https://img.shields.io/github/release/athena-framework/console.svg)](https://github.com/athena-framework/console/releases)
 
-**NOTE:** This repo assumes the component will be in the `athena-framework` org.  If it is to be used outside of the org, be sure to update URLs accordingly.
-
-1. Find/replace `COMPONENT_NAME` with the name of the component.  This is used as the shard's name.  E.x. `logger`.
-  1.1 Be sure to rename the file in `./src`, and `./spec` as well.
-
-1. Replace `NAMESPACE_NAME` with the name of the component's namespace.  Documentation for this component will be grouped under this. E.x. `Logger`.
-
-1. Find/replace `CREATOR_NAME` with your Github display name. E.x. `George Dietrich`.
-
-1. Find/replace `CREATOR_USERNAME` with your Github username. E.x. `blacksmoke16`.
-
-1. Find/replace `CREATOR_EMAIL` with your desired email
-
-   5.1 Can remove this if you don't wish to expose an email.
-
-1. Find/replace `ALIAS_NAME` with the three letter alias for this component; A + 2 letter shortcut to `NAMESPACE_NAME`.  E.x. `ALG`.
-
-1. Find/replace `DESCRIPTION` with a short description of what the component does.
-
-1. Define a repo secret `ACCESS_TOKEN` for CI deploys to work.
-
-   8.1 Alter [CI](./.github/workflows/ci.yml) and [Deployment](./.github/workflows/deployment.yml) scrips as needed.  Such as adding custom `crystal docs` command or adding an `Install Dependencies` step.
-
-Delete from here up
-# NAMESPACE_NAME
-
-[![CI](https://github.com/athena-framework/COMPONENT_NAME/workflows/CI/badge.svg)](https://github.com/athena-framework/COMPONENT_NAME/actions?query=workflow%3ACI)
-[![Latest release](https://img.shields.io/github/release/athena-framework/COMPONENT_NAME.svg)](https://github.com/athena-framework/COMPONENT_NAME/releases)
-
-DESCRIPTION
+Allows the creation of CLI based commands.
 
 ## Installation
 
 1. Add the dependency to your `shard.yml`:
 
 ```yaml
 dependencies:
-  athena-COMPONENT_NAME:
-    github: athena-framework/COMPONENT_NAME
+  athena-console:
+    github: athena-framework/console
+    version: ~> 0.1.0
 ```
 
 2. Run `shards install`
 
 ## Documentation
 
-Everything is documented in the [API Docs](https://athena-framework.github.io/COMPONENT_NAME/Athena/NAMESPACE_NAME.html).
+Everything is documented in the [API Docs](https://athena-framework.github.io/console/Athena/Console.html).
 
 ## Contributing
 
-1. Fork it (https://github.com/athena-framework/COMPONENT_NAME/fork)
+1. Fork it (https://github.com/athena-framework/console/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
 
-- [CREATOR_NAME](https://github.com/CREATOR_USERNAME) - creator and maintainer
+- [George Dietrich](https://github.com/blacksmoke16) - creator and maintainer

shard.yml

@@ -1,20 +1,20 @@
-name: athena-COMPONENT_NAME
+name: athena-console
 
 version: 0.1.0
 
 crystal: 0.35.0
 
 license: MIT
 
-repository: https://github.com/athena-framework/COMPONENT_NAME
+repository: https://github.com/athena-framework/console
 
-documentation: https://athena-framework.github.io/COMPONENT_NAME/Athena/NAMESPACE_NAME.html
+documentation: https://athena-framework.github.io/console/Athena/Console.html
 
-description: |
-  DESCRIPTION.
+Allows the creation of CLI based commands.: |
+  Allows the creation of CLI based commands.
 
 authors:
-  - CREATOR_NAME <CREATOR_EMAIL>
+  - George Dietrich <[email protected]>
 
 development_dependencies:
   ameba:

spec/athena-COMPONENT_TEMPLATE_spec.cr → spec/athena-console.cr

@@ -1,6 +1,6 @@
 require "./spec_helper"
 
-describe Athena::NAMESPACE_NAME do
+describe Athena::Console do
   it "works" do
     false.should eq(true)
   end

spec/spec_helper.cr

@@ -1,2 +1,2 @@
 require "spec"
-require "../src/athena-COMPONENT_NAME"
+require "../src/athena-console"

src/athena-console.cr

@@ -0,0 +1,6 @@
+# Convenience alias to make referencing `Athena::Console` types easier.
+alias ACON = Athena::Console
+
+module Athena::Console
+  VERSION = "0.1.0"
+end