Skip to content

Commit

Permalink
chore: fix README
Browse files Browse the repository at this point in the history
  • Loading branch information
florianvazelle committed Dec 11, 2023
1 parent e39852a commit 7bf8dfc
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 13 deletions.
11 changes: 7 additions & 4 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
ci:
autofix_commit_msg: 'chore(deps): pre-commit autoupdate'
autoupdate_commit_msg: 'chore(deps): pre-commit autoupdate'
repos:
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v4.4.0
Expand Down Expand Up @@ -35,10 +38,10 @@ repos:
args: ["--configfile", "pyproject.toml"]
additional_dependencies:
- bandit[toml]
#- repo: https://github.com/astral-sh/ruff-pre-commit
# rev: v0.0.282
# hooks:
# - id: ruff
- repo: https://github.com/astral-sh/ruff-pre-commit
rev: v0.0.282
hooks:
- id: ruff
- repo: https://github.com/pre-commit/mirrors-mypy
rev: v1.4.1
hooks:
Expand Down
11 changes: 2 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,23 +6,16 @@
![license](https://img.shields.io/badge/license-MIT-green?logo=open-source-initiative&logoColor=white)
[![standard-readme compliant](https://img.shields.io/badge/readme-standard-brightgreen.svg?logo=readme&logoColor=white)](https://github.com/RichardLitt/standard-readme)

![PyPI - Package Version](https://img.shields.io/pypi/v/magic_combo?logo=pypi&logoColor=white)
<!-- ![PyPI - Package Version](https://img.shields.io/pypi/v/greeter?logo=pypi&logoColor=white) -->

[![linting - Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v0.json)](https://github.com/charliermarsh/ruff)
[![format - black](https://img.shields.io/badge/format-black-000000.svg)](https://github.com/psf/black)
[![types - mypy](https://img.shields.io/badge/types-mypy-blue.svg)](https://github.com/python/mypy)

A template to create new python package..
A template to create new python package.

</div>

## Features

- Continuous integration via [GitHub Actions](https://help.github.com/en/actions/)
- Code formatting enforced by [gdformat](https://github.com/Scony/godot-gdscript-toolkit) for gdscript code, and [clang-format](https://clang.llvm.org/docs/ClangFormat.html) for shaders, via [pre-commit](https://github.com/pre-commit/pre-commit)
- Keep track of licenses and attribution by following the [reuse specification](https://reuse.software/spec/)
<!-- - Integrated test suite -->

## Usage

### Adjust the template to your needs
Expand Down

0 comments on commit 7bf8dfc

Please sign in to comment.