From eba8f2f6b84a7d20e8c513b05eab34b4baf0fd13 Mon Sep 17 00:00:00 2001 From: MartinuzziFrancesco Date: Fri, 20 Dec 2024 09:50:48 +0100 Subject: [PATCH] enhancements --- README.md | 30 ++++++++++++++++++++++++++---- docs/src/index.md | 2 +- 2 files changed, 27 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 992bb35..ebfb3f2 100644 --- a/README.md +++ b/README.md @@ -4,10 +4,32 @@
-[![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://MartinuzziFrancesco.github.io/RecurrentLayers.jl/dev/) -[![Build Status](https://github.com/MartinuzziFrancesco/RecurrentLayers.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/MartinuzziFrancesco/RecurrentLayers.jl/actions/workflows/CI.yml?query=branch%3Amain) -[![Coverage](https://codecov.io/gh/MartinuzziFrancesco/RecurrentLayers.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/MartinuzziFrancesco/RecurrentLayers.jl) -[![Aqua](https://raw.githubusercontent.com/JuliaTesting/Aqua.jl/master/badge.svg)](https://github.com/JuliaTesting/Aqua.jl) + +| **Documentation** | **Build Status** | **Julia** | **Testing** | +|:-----------------:|:----------------:|:---------:|:---------| +| [![docs][docs-img]][docs-url] | [![CI][ci-img]][ci-url] [![codecov][cc-img]][cc-url] | [![Julia][julia-img]][julia-url] [![Code Style: Blue][style-img]][style-url] | [![Aqua QA][aqua-img]][aqua-url] | + +[docs-img]: https://img.shields.io/badge/docs-stable-blue.svg +[docs-url]: https://MartinuzziFrancesco.github.io/RecurrentLayers.jl/dev/ + +[ci-img]: https://github.com/MartinuzziFrancesco/RecurrentLayers.jl/actions/workflows/CI.yml/badge.svg?branch=main +[ci-url]: https://github.com/MartinuzziFrancesco/RecurrentLayers.jl/actions/workflows/CI.yml?query=branch%3Amain + +[cc-img]: https://codecov.io/gh/MartinuzziFrancesco/RecurrentLayers.jl/branch/main/graph/badge.svg +[cc-url]: https://codecov.io/gh/MartinuzziFrancesco/RecurrentLayers.jl + +[julia-img]: https://img.shields.io/badge/julia-v1.10+-blue.svg +[julia-url]: https://julialang.org/ + +[style-img]: https://img.shields.io/badge/code%20style-blue-4495d1.svg +[style-url]: https://github.com/invenia/BlueStyle + +[aqua-img]: https://raw.githubusercontent.com/JuliaTesting/Aqua.jl/master/badge.svg +[aqua-url]: https://github.com/JuliaTesting/Aqua.jl + +[jet-img]: https://img.shields.io/badge/%E2%9C%88%EF%B8%8F%20tested%20with%20-%20JET.jl%20-%20red +[jet-url]: https://github.com/aviatesk/JET.jl +
diff --git a/docs/src/index.md b/docs/src/index.md index 6aa634d..3f50518 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -25,5 +25,5 @@ RecurrentLayers.jl extends [Flux.jl](https://github.com/FluxML/Flux.jl) recurren Contributions are always welcome! We specifically look for : - Recurrent cells you would like to see implemented - Benchmarks - - Any bugs and mistakes of course! + - Fixes for any bugs/errors - Documentation, in any form: examples, how tos, docstrings \ No newline at end of file