Skip to content

Commit 856bc66

Browse files
committed
common format
1 parent 36357ff commit 856bc66

File tree

1 file changed

+12
-4
lines changed

1 file changed

+12
-4
lines changed

README.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,15 +32,23 @@ This can save everybody time by adhering to 4 principles:
3232
4. **Consistency.** Your brain can scan a document much faster when it can
3333
anticipate its structure.
3434

35-
## Examples
35+
## Common format
3636

37-
Some READMEs generated using common readme:
37+
common-readme operates on the principle of *cognitive funneling*.
3838

39+
> Ideally, someone who's slightly familiar with your module should be able to
40+
> refresh their memory without hitting "page down". As your reader continues
41+
> through the document, they should receive a progressively greater amount of
42+
> knowledge. -- `perlmodstyle`
43+
44+
Here are some READMEs generated using common-readme:
45+
46+
- [`collide-2d-aabb-aabb`](https://github.com/noffle/collide-2d-aabb-aabb)
3947
- [`goertzel`](https://github.com/noffle/goertzel)
4048
- [`twitter-kv`](https://github.com/noffle/twitter-kv)
4149

42-
*([Create a PR](https://github.com/noffle/common-readme/pulls) to add yours
43-
here!)*
50+
*([Submit a pull request](https://github.com/noffle/common-readme/pulls) and add
51+
yours here!)*
4452

4553
## Usage
4654

0 commit comments

Comments
 (0)