From 88dd2e8f1757a8e09aa68113c783dbbf7679a51a Mon Sep 17 00:00:00 2001
From: jdmedlock <jdmedlock@gmail.com>
Date: Sat, 16 Mar 2019 22:02:11 -0500
Subject: [PATCH] Feature: Add GitHub Timeline app specification

Add GitHub Timeline app specification

Resolves: N/a
See also: N/a
---
 Projects/GitHub-Timeline-App.md | 52 +++++++++++++++++++++++++++++++++
 README.md                       |  1 +
 2 files changed, 53 insertions(+)
 create mode 100644 Projects/GitHub-Timeline-App.md

diff --git a/Projects/GitHub-Timeline-App.md b/Projects/GitHub-Timeline-App.md
new file mode 100644
index 00000000..519c24f1
--- /dev/null
+++ b/Projects/GitHub-Timeline-App.md
@@ -0,0 +1,52 @@
+# GitHub Timeline
+
+API's and graphical representation of information are hallmarks of modern
+web applications. GitHub Timeline combines the two to create a visual history
+of a users GitHub activity. 
+
+The goal of GitHup Timeline is accept a GitHub user name and produce a
+timeline containing each repo and annotated with the repo names, the date
+they were created, and their descriptions. The timeline should be one that 
+could be shared with a prospective employer. It should be easy to read and
+make effective use of color and typography.
+
+Only public GitHub repos should be displayed. 
+
+## User Stories
+
+-   [ ] User can enter a GitHub user name 
+-   [ ] User can click a 'Generate' button to create and display the named
+users repo timeline
+-   [ ] User can see a warning message if the GitHub user name is not a valid
+GitHub user name.
+
+## Bonus features
+
+-   [ ] User can see a summary of the number of repos tallied by the year they
+were created
+
+## Useful links and resources
+
+GitHub offers two API's you may use to access repo data. You may also choose
+to use an NPM package to access the GitHub API.
+
+Documentation for the GitHub API can be found at:
+
+- [GitHub REST API V3](https://developer.github.com/v3/)
+- [GitHub GraphQL API V4](https://developer.github.com/v4/)
+
+Sample code showing how to use the GitHub API's are:
+
+- [GitHub REST API client for JavaScript ](https://github.com/octokit/rest.js/)
+- [GitHub GraphQL API client for browsers and Node](https://github.com/octokit/graphql.js)
+
+You can use this CURL command to see the JSON returned by the V3 REST API for
+your repos:
+```
+curl -u "user-id" https://api.github.com/users/user-id/repos
+```
+
+## Example projects
+
+- [CSS Timeline](https://codepen.io/NilsWe/pen/FemfK)
+- [Building a Vertical Timeline With CSS and a Touch of JavaScript](https://codepen.io/tutsplus/pen/QNeJgR)
\ No newline at end of file
diff --git a/README.md b/README.md
index 09b0c66d..253f7282 100644
--- a/README.md
+++ b/README.md
@@ -32,6 +32,7 @@ Each project has the following **features**:
 | [Color Cycle](./Projects/Color-Cycle-App.md)                       |
 | [Flashcards App](./Projects/FlashCards-App.md)                     |
 | [Flip Image](./Projects/Flip-Image-App.md)                         |
+| [GitHub Timeline](./Projects/GitHub-Timeline-App.md)               |
 | [Kudos Slackbot](./Projects/Kudos-Slackbot.md)                     |
 | [Lorem Ipsum Generator](./Projects/Lorem-Ipsum-Generator.md)       |
 | [Markdown Previewer](./Projects/Markdown-Previewer.md)             |