Skip to content

Commit d2a74ba

Browse files
committed
readme updates
1 parent 4c640ea commit d2a74ba

File tree

1 file changed

+12
-13
lines changed

1 file changed

+12
-13
lines changed

readme.txt

Lines changed: 12 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Here is a skeleton for a README.md
1+
README.md
22

33
Synopsis
44
CodeExample
@@ -8,30 +8,29 @@ API Reference
88
Tests
99
Contributors
1010
License
11-
Synopsis
12-
1311

14-
Readme
15-
A short introduction and/ or overview explaining the project. This description matches descriptions added for package managers (Gemspec, package.json, etc.)
12+
Synopsis
13+
This application will watch your learning progress on a number of websites. It will output a display of your badges in your own website as a pasteable widget.
1614

1715
Example
18-
Make the API obvious. Short, concise demonstration that enables any developer to use your code as a tool for problem solving.
16+
Using Team Treehouse API, we use dev tools to select images as code. Problem solving is updating changing data.
1917

2018
Motive/Influences
21-
Why are we creating this and how long will it last? Will there be any maintenance? Where did our ideas come from? Where did we lift code?
19+
We are creating this because we are developers and this tool will be of use to us. We will maintain this site as long as is necessary to keep track of our badges and learning progress....
20+
Our influences are the Team Treehouse API. We use github and slack.
2221

2322
Installation
24-
Simple How-to
23+
Go to the insignia website. select import badge widget. customize widget.
2524

2625
API Reference
27-
Reference documentation stored as a library, glossary, index or link to these.
26+
Team Treehouse, Nate's Magic website, Nate's Fixit Website, Nates Emporium
2827

2928
Test
30-
Describe and show how to run the tests with code examples. What testing software?
29+
It('should do specific things', function(){} ...);
30+
We are using npm to test our values and our data.
3131

3232
Contributors
33-
Who's on it? What issue tickets initiated the project? Current?
33+
Aaron, Jose, Audrey, Prakhash contributed. Initiated as a desire to keep track of our learning progress on 5.7.2015 Currently building...
3434

3535
License
36-
Describe the license (MIT, Apache, etc.) in a word or two.
37-
36+
AllRightsReserved

0 commit comments

Comments
 (0)