feat: add more sections to README file

airscripts · airscripts · commit 802c5e57a4b3 · 2023-07-30T01:41:14.000+02:00
diff --git a/.github/ISSUE_TEMPLATE/bug.md b/.github/ISSUE_TEMPLATE/bug.md
@@ -4,7 +4,6 @@ about: Create a report to help us improve
 title: ''
 labels: bug
 assignees: airscripts
-
 ---
 
 **Describe the bug**
diff --git a/.github/ISSUE_TEMPLATE/feature.md b/.github/ISSUE_TEMPLATE/feature.md
@@ -4,7 +4,6 @@ about: Suggest an idea for this project
 title: ''
 labels: feature
 assignees: airscripts
-
 ---
 
 **Is your feature request related to a problem? Please describe.**
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,13 +1,18 @@
 # Changelog
 All notable changes to this project will be documented in this file.  
-
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) with some edits,
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).  
-&nbsp;
 
-## 🎉 1.0.0
+# 1.1.0
+
+## What's Changed
+* feat: add more sections to README file
+
+**Full Changelog**: https://github.com/airscripts/analscript/compare/1.0.0...1.1.0
+
+# 1.0.0
 
-### What's Changed
+## What's Changed
 * feat: add SECURITY.md
 * feat: add CHANGELOG.md
 * feat: add README.md
@@ -17,5 +22,4 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 * feat: add PULL_REQUEST_TEMPLATE.md
 * feat: add issue templates
 
-### Full Changelog 
-https://github.com/Airscripts/emdees/commits/1.0.0
+**Full Changelog**: https://github.com/Airscripts/emdees/commits/1.0.0
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -2,7 +2,6 @@
 # Contributor Covenant Code of Conduct
 
 ## Our Pledge
-
 We as members, contributors, and leaders pledge to make participation in our
 community a harassment-free experience for everyone, regardless of age, body
 size, visible or invisible disability, ethnicity, sex characteristics, gender
@@ -14,7 +13,6 @@ We pledge to act and interact in ways that contribute to an open, welcoming,
 diverse, inclusive, and healthy community.
 
 ## Our Standards
-
 Examples of behavior that contributes to a positive environment for our
 community include:
 
@@ -38,7 +36,6 @@ Examples of unacceptable behavior include:
   professional setting
 
 ## Enforcement Responsibilities
-
 Community leaders are responsible for clarifying and enforcing our standards of
 acceptable behavior and will take appropriate and fair corrective action in
 response to any behavior that they deem inappropriate, threatening, offensive,
@@ -50,15 +47,13 @@ not aligned to this Code of Conduct, and will communicate reasons for moderation
 decisions when appropriate.
 
 ## Scope
-
 This Code of Conduct applies within all community spaces, and also applies when
 an individual is officially representing the community in public spaces.
 Examples of representing our community include using an official e-mail address,
 posting via an official social media account, or acting as an appointed
 representative at an online or offline event.
 
 ## Enforcement
-
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
 reported to the community leaders responsible for enforcement at
 <support@airscript.it>.
@@ -68,12 +63,10 @@ All community leaders are obligated to respect the privacy and security of the
 reporter of any incident.
 
 ## Enforcement Guidelines
-
 Community leaders will follow these Community Impact Guidelines in determining
 the consequences for any action they deem in violation of this Code of Conduct:
 
 ### 1. Correction
-
 **Community Impact**: Use of inappropriate language or other behavior deemed
 unprofessional or unwelcome in the community.
 
@@ -82,7 +75,6 @@ clarity around the nature of the violation and an explanation of why the
 behavior was inappropriate. A public apology may be requested.
 
 ### 2. Warning
-
 **Community Impact**: A violation through a single incident or series
 of actions.
 
@@ -94,7 +86,6 @@ like social media. Violating these terms may lead to a temporary or
 permanent ban.
 
 ### 3. Temporary Ban
-
 **Community Impact**: A serious violation of community standards, including
 sustained inappropriate behavior.
 
@@ -105,7 +96,6 @@ with those enforcing the Code of Conduct, is allowed during this period.
 Violating these terms may lead to a permanent ban.
 
 ### 4. Permanent Ban
-
 **Community Impact**: Demonstrating a pattern of violation of community
 standards, including sustained inappropriate behavior,  harassment of an
 individual, or aggression toward or disparagement of classes of individuals.
@@ -114,7 +104,6 @@ individual, or aggression toward or disparagement of classes of individuals.
 the community.
 
 ## Attribution
-
 This Code of Conduct is adapted from the [Contributor Covenant][homepage],
 version 2.0, available at
 [https://www.contributor-covenant.org/version/2/0/code_of_conduct.html][v2.0].
@@ -130,4 +119,4 @@ at [https://www.contributor-covenant.org/translations][translations].
 [v2.0]: https://www.contributor-covenant.org/version/2/0/code_of_conduct.html
 [Mozilla CoC]: https://github.com/mozilla/diversity
 [FAQ]: https://www.contributor-covenant.org/faq
-[translations]: https://www.contributor-covenant.org/translations
+[translations]: https://www.contributor-covenant.org/translations
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,5 +1,2 @@
 # Contributing
-When contributing to this repository, please first discuss the change you wish to make via issue,
-email, or any other method with the owners of this repository before making a change.  
-
-Please note we have a code of conduct, please follow it in all your interactions with the project.
+When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository, ensuring you follow the [Code of Conduct](https://github.com/Airscripts/emdees/blob/main/CODE_OF_CONDUCT.md).  
diff --git a/README.md b/README.md
@@ -1,24 +1,41 @@
-# 🪶 Emdees
+# Emdees
 A collection of useful files for new repository's scaffolding.
 
-## 📦 Install
+## Contents
+- [Installation](#installation)
+- [Usage](#usage)
+- [Resources](#resources)
+- [Contributing](#contributing)
+- [Support](#support)
+- [License](#license)
+
+## Installing
 Follow the steps below to make use of Emdees.
 
 1. Clone this repository:
 ```bash
 git clone https://github.com/Airscripts/emdees.git
 ```
 
-## 🤝 Contribute
+## Usage
+In order to use this project, just click the use as template in the repository's page.
+
+## Resources
+Here you can list some useful resources about this project:
+- [GitHub Page](https://ghio.airscript.it/emdees): project's GitHub page.
+
+## Contributing
 Contributions and suggestions about how to improve this project are welcome!
 
-## 💚 Support
+## Support
 If you want to support my work you can do it with the links below.
 
 Choose what you find more suitable for you:  
 - [Support me on GitHub](https://github.com/sponsors/Airscripts)
 - [Support me via ko-fi](https://ko-fi.com/airscript)
 - [Support me via linktr.ee](https://linktr.ee/airscript)
 
-## 💳 License  
+*As of my personal preference, I'do go with GitHub Sponsors.*
+
+## License  
 This repository is licensed under [GPL-3.0 License](https://github.com/Airscripts/emdees/blob/main/LICENSE).
diff --git a/SECURITY.md b/SECURITY.md
@@ -3,7 +3,7 @@
 ## Supported Versions
 | Version | Supported          |
 | ------- | ------------------ |
-| 1.x.x   | :white_check_mark: |
+| 1.1.x   | :white_check_mark: |
 
-## Reporting a Vulnerability
-To report a vulnerability, open an [issue](https://github.com/Airscripts/x/issues/new/choose).
+## Reporting Vulnerability
+To report a vulnerability, open an [issue](https://github.com/Airscripts/emdees/issues/new/choose).
diff --git a/VERSION b/VERSION
@@ -1 +1 @@
-1.0.0
+1.1.0
