Skip to content

Commit

Permalink
feat: add readme and art banner
Browse files Browse the repository at this point in the history
  • Loading branch information
abd3lraouf committed Jul 16, 2022
1 parent d4f03e9 commit 650bbe6
Show file tree
Hide file tree
Showing 3 changed files with 124 additions and 0 deletions.
47 changes: 47 additions & 0 deletions .github/release-drafter.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
# Config for https://github.com/apps/release-drafter
name-template: "$RESOLVED_VERSION 🦉 "
tag-template: "$RESOLVED_VERSION"
categories:
- title: "🚀 New Features and Enhancements "
labels:
- "feature"
- "enhancement"
- "ui"
- title: "💣 Breaking Changes "
labels:
- "breaking-change"
- title: "🏇 Optimizations "
labels:
- "optimize"
- "performance"
- title: "🐛 Bug Fixes "
labels:
- "bugfix"
- "bug"
- title: "🔨 Maintenance "
labels:
- "maintenance"
- "refactoring"
- "chore"
- "build"
- "ci"
change-template: "- $TITLE (#$NUMBER) @$AUTHOR"
version-resolver:
major:
labels:
- "major"
minor:
labels:
- "minor"
patch:
labels:
- "patch"
default: patch
exclude-labels:
- "skip-changelog"
template: |
## Changes
$CHANGES
Thanks again to $CONTRIBUTORS for the contributions! 🎉
77 changes: 77 additions & 0 deletions Readme.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
|Banner|

|CI Scanner| |CI Build| |Maintainability| |Packages|

|
.. contents:: **Contents**
:backlinks: none

Installation
============

Package
-------

The latest version of the packages can be found on the GitHub `releases page <https://github.com/abd3lraouf/Semantic/releases>`_.

Root project `build.gradle`
^^^^^^^^^^^^^^^^^^^^^
.. code-block:: groovy
repositories {
maven {
url = uri("https://maven.pkg.github.com/abd3lraouf/Semantic")
}
}
App project `build.gradle`
^^^^^^^^^^^^^^^^^^^^^
.. code-block:: groovy
dependencies {
implementation("dev.abd3lraouf.learn.Semantic:sdk:<latest-release>")
}
|Packages|

Contributing
============

|Maintainability|

Thanks to all our contributors! I'm very grateful for all the work you've done to make Open source projects better.

|Contribs|

Copyright
=========

This project is distributed under the Apache license version 2.0 (see the LICENSE file in the project root).

By submitting a pull request to this project, you agree to license your contribution under the Apache license version
2.0 to this project.


.. |Banner| image:: https://github.com/abd3lraouf/Semantic/blob/master/art/automated-semantic-versioning.png
:target: https://github.com/abd3lraouf/Semantic
:alt: Semantic logo

.. |CI Scanner| image:: https://github.com/abd3lraouf/Semantic/actions/workflows/code-scanner.yml/badge.svg
:target: https://github.com/abd3lraouf/Semantic/actions/workflows/code-scanner.yml
:alt: CI code scanner

.. |CI Build| image:: https://github.com/abd3lraouf/Semantic/actions/workflows/sdk-ci.yml/badge.svg
:target: https://github.com/abd3lraouf/Semantic/actions/workflows/sdk-ci.yml
:alt: CI build

.. |Maintainability| image:: https://codeclimate.com/github/abd3lraouf/Semantic/badges/gpa.svg
:target: https://codeclimate.com/github/abd3lraouf/Semantic
:alt: Code Climate

.. |Packages| image:: https://img.shields.io/github/v/release/abd3lraouf/Semantic?label=sdk&logo=GitHub
:target: https://github.com/abd3lraouf/Semantic/packages/1542751
:alt: sdk

.. |Contribs| image:: https://contrib.rocks/image?repo=abd3lraouf/Semantic
:target: https://github.com/abd3lraouf/Semantic/graphs/contributors
:alt: Contributors
Binary file added art/automated-semantic-versioning.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 650bbe6

Please sign in to comment.