Skip to content

Instantly share code, notes, and snippets.

@nevir

nevir/README.md

Last active December 15, 2015 01:49
Show Gist options
  • Star 1 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save nevir/5182712 to your computer and use it in GitHub Desktop.
Save nevir/5182712 to your computer and use it in GitHub Desktop.
Download ZIP
README-driven project metadata
Raw
README.md

Package Name (1.2.3)

Short package description; useful for quick one-liners when displaying information about it on various sites/contexts.

Normal Readme Stuff

Blah, blah blah. The order of readme sections doesn't matter: organize it however you like.

The parser would be looking for headers w/ specific titles (Dependencies, Development Dependencies, ???), and the first section only.

...

Dependencies

Development Dependencies

...and maybe more readme stuff goes here...

@nevir
Copy link
Author

nevir commented Mar 17, 2013

Some notes and ideas:

  • Any links/images in the first header would be ignored (e.g. badges)
  • The order of the Dependencies/Development Dependencies sections shouldn't matter; you can place them anywhere in the readme
  • Header level doesn't matter
  • For dependencies, the only parsed text is the link title; URL is ignored. In fact, plain text is fine too.

@AlekSi
Copy link

AlekSi commented Mar 18, 2013

Interesting idea. nut.json is there to stay (it's too late for breaking changes), but probably nut generate may be used to update README according to nut.json content.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment