Athena Bundle Template

Template repo for creating a new Athena bundle. Scaffolds the Crystal shard's structure.

NOTE: This repo assumes the bundle will be in the athena-framework org. If it is to be used outside of the org, be sure to update URLs accordingly and setup CI.

1. Find/replace BUNDLE_NAME with the name of the bundle. This is used as the shard's/repo name. E.x. logger, NOT logger-bundle 1.1 Be sure to rename the file in ./src as well.

2. Replace NAMESPACE_NAME with the name of the component's namespace. Documentation for this component will be grouped under this. E.x. LoggerBundle.

3. Find/replace CREATOR_NAME with your Github display name. E.x. George Dietrich.

4. Find/replace CREATOR_USERNAME with your Github username. E.x. blacksmoke16.

5. Find/replace CREATOR_EMAIL with your desired email 5.1 Can remove this if you don't wish to expose an email.

6. Find/replace DESCRIPTION with a short description of what the component does.

7. Add some initial documentation to docs/README.md.

8. Specify the athena-dependency_injection dependency's supported version(s). E.x. version: ~> 0.4

Delete from here up

NAMESPACE_NAME

DESCRIPTION.

Getting Started

Checkout the Documentation.

Contributing

Read the general Contributing Guide for information on how to get started.