Readme Parrot
馃О A simple little README template.
README-Parrot
A simple little README template. Aren't all your READMEs kind of the same?
Key Features 路 Installation 路 How to Use 路 Contributing 路 License
Key Features
README-Parrot provides a simple template for your side project READMEs. Try it out!
Installation
To clone and run this application, you need Git and npm. Run from your command line:
# Clone the repository
$ git clone [email protected]:LenaSchnedlitz/readme-parrot.git
# Go into the freshly downloaded directory
$ cd readme-parrot
# Install dependencies
$ npm i
How to Use
This application was built with Svelte. To start development mode, follow the installation steps described above and run (from your command line):
$ npm run dev
For production builds, run:
# Build the application
$ npm run build
# Start the application from latest build
$ npm run start
Contributing
Merge requests and bug reports are welcome. I will try my best to process them as soon as possible, but please be patient - my spare time is (sadly) very limited.
License
MIT 路 Credits are much appreciated :heart:
