Parquet icon indicating copy to clipboard operation
Parquet copied to clipboard

Expand ReadMe.md

Open mxashlynn opened this issue 6 years ago • 2 comments

Flesh out the project introduction in the README. For inspo, see:

  • https://github.com/noopkat/avrgirl-arduino/blob/master/README.md

mxashlynn avatar Apr 01 '19 02:04 mxashlynn

Consider the README section on:

  • https://guides.github.com/features/wikis/

mxashlynn avatar Apr 01 '19 03:04 mxashlynn

Also consider:

Parquet

Parquet will solve your problem with _____ by providing _____.

Example

Here's how to use it:

import project
# Get your stuff done
project.do_stuff()

Features

  • Feature 1
  • Feature 2

Installation

Install Parquet by:

1) something something
2) something something

Contribute

  • Issue Tracker: github.com/mxashlynn/ParquetClassLibrary/issues/39
  • Source Code: github.com/mxashlynn/ParquetClassLibrary/

Support

If you are having issues, please let us know. You can contact the maintainers at ______.

License

The project is licensed under and according to the ________ license.

mxashlynn avatar Apr 01 '19 03:04 mxashlynn