[Update] Minor changes in Readme (#165)

* updated readme

* added badge to readme

* added sponsor banner to readme

* remove email link

* updated readme

* update contribution guidelines

* cleanup dev docs

* style warning note

* updated Contribute financially section in readme

Readme.md

@@ -31,50 +31,63 @@
 
 [![Deploy to Production](https://github.com/nisrulz/app-privacy-policy-generator/actions/workflows/firebase-hosting-merge.yml/badge.svg)](https://github.com/nisrulz/app-privacy-policy-generator/actions/workflows/firebase-hosting-merge.yml) [![Deploy to Firebase Hosting on PR](https://github.com/nisrulz/app-privacy-policy-generator/actions/workflows/firebase-hosting-pull-request.yml/badge.svg)](https://github.com/nisrulz/app-privacy-policy-generator/actions/workflows/firebase-hosting-pull-request.yml)
 
-## Contribution
+## Screenshots
 
-[Read the dev docs](dev-doc.md) to
+<img src="img/sc_1.png" alt="App Privacy Policy Generator" width=360 /><img src="img/sc_2.png" alt="App Privacy Policy Generator" width=360 /><img src="img/sc_3.png" alt="App Privacy Policy Generator" width=360 />
 
-- [Add a new 3rd party service to the web app](https://github.com/nisrulz/app-privacy-policy-generator/blob/master/dev-doc.md#contributing-more-3rd-party-services-links)
-- [Add a new template for Privacy Policy or Terms & Conditions](https://github.com/nisrulz/app-privacy-policy-generator/blob/master/dev-doc.md#development)
-- [Update the web app for new features/bugfixes](https://github.com/nisrulz/app-privacy-policy-generator/blob/master/dev-doc.md#development)
+## Project Support
 
-## Pull Requests
+- Before contacting me with issues, please visit the [Issue Tracker](https://github.com/nisrulz/app-privacy-policy-generator/issues) and see if issue was already added there. Just in case.
+- If you want to report a bug in the project, please use the [Issue Tracker](https://github.com/nisrulz/app-privacy-policy-generator/issues) to [**open an issue**](https://github.com/nisrulz/app-privacy-policy-generator/issues/new/choose).
+- If you want to discuss the project with the community, join the [Discussion](https://github.com/nisrulz/app-privacy-policy-generator/discussions).
+- If needed, you can also contact me on [Twitter](https://twitter.com/nisrulz).
 
-I welcome and encourage all pull requests. It usually will take me within 24-48 hours to respond to any issue or request. Here are some basic rules to follow to ensure timely addition of your request:
+## Contributing
 
-1. If its a feature, bugfix, or anything please only change code to what you specify.
-2. Please keep PR titles easy to read and descriptive of changes, this will make them easier to merge :)
-3. Check for existing [issues](https://github.com/nisrulz/app-privacy-policy-generator/issues) first, before filing an issue.
-4. Have fun!
+This project's contributions work a little different than most GitHub projects. If you have a small bug fix or typo fix, please open a Pull Request(PR) directly to this repository.
 
-## Author & Contributors
+In order to reduce burnout by limiting the maintenance overhead of reviewing and validating third-party code, this project is open to code contributions for **bug fixes only**. Features carry a long-term maintenance burden so they will not be accepted at this time.
+
+If you would like to contribute a feature, please follow these steps:
+
+1. Check for existing [issues](https://github.com/nisrulz/app-privacy-policy-generator/issues) first, before filing an issue.
+2. Discuss the feature in the new/existing issue.
+3. Create a pull request from **your fork** to this repository, once details are clear and approved by maintainer.
+4. Post a link to your pull request in the issue for consideration.
+
+It's likely that code style and implementation details will need to be tweaked so it's easier to for me to grab your
+implementation as a starting point when implementing a feature.
 
-This project was created by [Nishant Srivastava](https://github.com/nisrulz/nisrulz.github.io#nishant-srivastava) but hopefully developed and maintained by many others. See the [the list of contributors here](https://github.com/nisrulz/app-privacy-policy-generator/graphs/contributors).
+Additionally, make sure to [read the dev docs](dev-doc.md) to
 
-## Ways You Can Help/Support this project
+- [Add a new 3rd party service to the web app](https://github.com/nisrulz/app-privacy-policy-generator/blob/master/dev-doc.md#contributing-more-3rd-party-services-links)
+- [Add a new template for Privacy Policy or Terms & Conditions](https://github.com/nisrulz/app-privacy-policy-generator/blob/master/dev-doc.md#development)
+- [Update the web app for new features/bugfixes](https://github.com/nisrulz/app-privacy-policy-generator/blob/master/dev-doc.md#development)
+
+## Contribute financially
+
+Servers aren't free and running/maintaining this project isn't free either.
 
-- **Star** this repository and tell all your friends about it.
-- **Watch** for new releases to get an update if something happens.
-- [**Open an Issue**](https://github.com/nisrulz/app-privacy-policy-generator/issues/new/choose) if you catch any error in copy text or within the project itself.
-- **Open a Pull Request** to include support for adding more 3rd party service's links or fixes against [existing issues](https://github.com/nisrulz/app-privacy-policy-generator/issues).
+Please consider contributing on [GitHub sponsor](https://github.com/sponsors/nisrulz) to offer continued support. You can do a one-time contribution or set up a recurring monthly contribution.
 
-- If you can spare a few 💵:
+[![sponsoring monthly](img/sponsor_banner.png)](https://github.com/sponsors/nisrulz)
 
-  - [Buy me a coffee :coffee:](https://www.buymeacoffee.com/nisrulz) (one-time),
-  - or [Sponsor me on GitHub](https://github.com/sponsors/nisrulz) (recurring monthly).
+_Alternatively you can fuel my late night programming sessions by [buying me coffee :coffee:](https://www.buymeacoffee.com/nisrulz)._
+
+## Support this project
 
 - Tell me you like this project or how it helped you out!
+  - **Star** this repository and tell all your friends about it.
+  - [Comment in the project's guestbook](https://github.com/nisrulz/app-privacy-policy-generator/issues/65) :blush:
+  - Reach out on [Twitter](https://twitter.com/nisrulz)
 
-  - [Comment in the project's guestbook](https://github.com/nisrulz/app-privacy-policy-generator/issues/65) :blush:,
-  - Reach out on [Twitter](https://twitter.com/nisrulz),
-  - or [send a nice email my way](mailto:[email protected])!
+Thanks for your interest in this project :heart:
 
-Thanks for your interest in this software :heart:
+## Author & Contributors
 
-## Screenshots
+This project was created by [Nishant Srivastava](https://github.com/nisrulz/nisrulz.github.io#nishant-srivastava) but hopefully developed and maintained by many others.
 
-<img src="img/sc_1.png" alt="App Privacy Policy Generator" width=360 /><img src="img/sc_2.png" alt="App Privacy Policy Generator" width=360 /><img src="img/sc_3.png" alt="App Privacy Policy Generator" width=360 />
+See the [the list of contributors here](https://github.com/nisrulz/app-privacy-policy-generator/graphs/contributors).
 
 ## License
 

dev-doc.md

@@ -1,24 +1,28 @@
 # Development
 
-The web app uses 
+The web app uses
+
 - [VueJs](https://vuejs.org/) - For templating and reactive updates in the DOM
 - [Pug-CLI](https://github.com/pugjs/pug-cli) - To convert pug templates to html and merge partials into single [`index.html`](public/index.html) file.
 - [SASS-CLI](https://sass-lang.com/documentation/cli) - To convert sass templates to css and merge partials into single [`style.css`](public/css/style.css) file.
 - [js-yaml-CLI](https://github.com/nodeca/js-yaml#cli-executable) - To convert yaml templates to json and generate the [`thirdpartyservices.js`](public/js/thirdpartyservices.js) file.
 - [Firebase Hosting](https://firebase.google.com/docs/hosting/) - For Hosting
 
 If you wish to modify the code for the webapp, then look into [`src`](src) directory.
+
 - Privacy Policy templates are under [`src/includes/content/privacy_policy`](src/includes/content/privacy_policy)
 - Terms & Conditions templates are under [`src/includes/content/tnc`](src/includes/content/tnc)
 
-The webapp is setup in a way that it is made up of 
+The webapp is setup in a way that it is made up of
+
 - html partials written in pug templating language
 - css partials written in sass templating language
 - js config for third party services info written in yaml templating language
 
 ...all of which is compiled into a single `index.html` file which lives under [`public`](public) directory. Styles are compiled into a single `style.css` file under [`public/css`](public/css) directory and third party services info is compiled into a single `thirdpartyservices.js` under [`public/js`](public/js) referenced directly in the `index.html` file.
 
 To compile the code under `src` folder, simply execute the helper bash script [`render.sh`](render.sh) at the root of the repo inside a terminal:
+
 ```sh
 ./render.sh
 ```
@@ -29,7 +33,7 @@ Open `index.html` to view the full webapp 🎉
 
 ## Contributing more 3rd Party Service's links
 
-The webapp uses a JSON array to populate the list of 3rd party services section. This JSON array is generated from another yaml file. 
+The webapp uses a JSON array to populate the list of 3rd party services section. This JSON array is generated from another yaml file.
 
 If you want contribute a new 3rd party service for the section then open a Pull Request which simply adds a new item in the YAML file [`src/includes/yaml/thirdpartyservices.yml`](src/includes/yaml/thirdpartyservices.yml)
 
@@ -44,11 +48,12 @@ The format is very simple and you only need to provide the below fields:
     privacy: https://www.google.com/policies/privacy/
     terms: https://policies.google.com/terms
 ```
+
 > Note: The value of model is the same as the the field below it. i.e `model: gps` and `gps: false`. This is required by the code. Make sure this is maintained.
 
 Additionally, you also will have to drop the logo image into the [`public/images/third_party_logos/`](public/images/third_party_logos/) folder. Make sure the logo is **160 × 160** in size.
 
-# Deployment
+### Deployment
 
 In order to deploy with the web app and Firebase hosting you would need to setup Firebase CLI.
 
@@ -68,7 +73,8 @@ To serve locally for testing, run: `firebase serve --only hosting`
 
 ### Deploy to Production
 
-> Note: This can only be done by maintainers who have access to Firebase console!
+> **Warning**
+> This can only be done by maintainers who have access to Firebase console!
 
 - First, login by executing command: `firebase login`
 - Next,To deploy to production,run: `firebase deploy -m "3.0.9"`