Skip to content

Commit

Permalink
add readme, application screenshot
Browse files Browse the repository at this point in the history
  • Loading branch information
michaeldyrynda committed May 9, 2016
1 parent 4a90653 commit 5b0b1cf
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Readme generator

## Introduction

![Readme generator screenshot](readme-generator-screenshot.png)

Developers love to share code in the form of packages, full apps, or tiny modules. Sharing is great, but one area that a lot of developers forget about is the readme file. This file is now arguably one of the most important pieces for your project and one that a lot of users don’t spend any time on.

When looking for an existing open source project to solve a problem you had, you've probably asked yourself one or more of the following questions:

1. Will it solve my problem?
2. Can I trust this code?
3. Can I trust the team/developer who created it?
4. Will I be able to get help if I'm stuck?
5. Are issues or pull requests dealt with?
6. Am I willing to keep this updated if the project dies?
7. Can I build this easier myself?

This [simple application](https://michaeldyrynda.github.io/readme-generator) assists you in writing a readme for your own projects in a way that guides you to answering these questions.

## Learn more

Check out [Eric L Barnes'](https://twitter.com/ericlbarnes) article on [how to write a README that rocks](https://dotdev.co/how-to-write-a-readme-that-rocks-bc29f279611a) for the inspiration behind this generator.
Binary file added readme-generator-screenshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 5b0b1cf

Please sign in to comment.