Skip to content

Commit

Permalink
want to keep the README as short as possible.
Browse files Browse the repository at this point in the history
  • Loading branch information
@egonSchiele
egonSchiele committed Apr 2, 2015
1 parent 500f96a commit 3553ceb
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
View file
Expand Up @@ -2,7 +2,7 @@

Contracts let you clearly – even beautifully – express how your code behaves, and free you from writing tons of boilerplate, defensive code.

You can think of contracts as `assert` on steroids. They check inputs, and outputs of functions and invarients of data. Read more about [design by contract](http://en.wikipedia.org/wiki/Design_by_contract) on Wikipedia.
You can think of contracts as `assert` on steroids.

## Installation

Expand Down

3 comments on commit 3553ceb

@nixpulvis
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why keep the readme so short. The Readme is the first and sometimes only place people generally look for info on libraries these days.

@PikachuEXE
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the "Read more" can be moved to a new section at the bottom.
I need more things to read (sometimes)

@egonSchiele
Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree that this is useful information to have. But I like keeping the readme short...if it's too long, people may not read it at all.

Please sign in to comment.