Your repository must include a readme.md
that answers the following questions regarding your subject. No need to write a book!
- Why did you choose this subject?
- How were you first made aware of it?
- What problem does it solve?
- How does it solve the problem (conceptually)?
- Why does one use it?
- What are the alternatives?
- What is it similar to, if anything?
- What is the history of this technology?
- Who built it and why?
- Who is maintaining it?
- What is your opinion on the technology after having built something with it?
- What are the biggest conceptual hurdles (if any) you encountered when researching this?
- What resources do you recommend for interested students?
- What article or forum was most helpful to you in learning this?
- What are 3 interview questions one might be asked about this technology?
Also, please include the instructions necessary to...
- Run your example.
- Do I need to run
bower install
? Do I need an API key?
- Do I need to run
- Use your subject.
- Do I need to include it in my HTML with
<script>
tags? Do I need tobrew install
anything? Can I deploy it to Heroku?
- Do I need to include it in my HTML with