Add readme

codyjdalton · Apr 24, 2021 · 0a92356 · 0a92356
1 parent ad986c2
commit 0a92356
Show file tree

Hide file tree

Showing 4 changed files with 772 additions and 109 deletions.
diff --git a/.travis.yml b/.travis.yml
@@ -0,0 +1,8 @@
+language: node_js
+node_js:
+- stable
+install:
+- npm install
+script:
+- npm run test
+after_script: cat coverage/lcov.info | node_modules/coveralls/bin/coveralls.js
diff --git a/README.md b/README.md
@@ -0,0 +1,11 @@
+[![Build Status](https://travis-ci.org/codyjdalton/enigma.svg?branch=main)](https://travis-ci.org/codyjdalton/enigma) [![Coverage Status](https://coveralls.io/repos/github/enigma/litstack/badge.svg?branch=main)](https://coveralls.io/github/codyjdalton/enigma?branch=main)
+
+# Enigma
+
+Simple implemention of an Enigma machine
+
+## Getting Started
+
+```
+> npm install; npm test;
+```