Init README 📑

2 years ago · 38f6e9d739
parent 5d2ba24d90
commit 38f6e9d739
2 changed files with 114 additions and 2 deletions
--- a/Documentation/Images/Banner-AllIn.png
+++ b/Documentation/Images/Banner-AllIn.png
--- a/README.md
+++ b/README.md
@ -1,3 +1,115 @@
-# Api
+<div align = center>

-Dotnet API for AllIn App
+  <img src="Documentation/Images/Banner-AllIn.png" />
+    
+---
+
+&nbsp; ![Docker](https://img.shields.io/badge/Docker-2496ED.svg?style=for-the-badge&logo=Docker&logoColor=white)
+&nbsp; ![CSharp](https://img.shields.io/badge/C%20Sharp-239120.svg?style=for-the-badge&logo=C-Sharp&logoColor=white)
+&nbsp; ![Visual Studio](https://img.shields.io/badge/Visual%20Studio-5C2D91.svg?style=for-the-badge&logo=Visual-Studio&logoColor=white)
+&nbsp; ![Swagger](https://img.shields.io/badge/Swagger-85EA2D.svg?style=for-the-badge&logo=Swagger&logoColor=black)
+&nbsp; ![.NET](https://img.shields.io/badge/.NET-512BD4.svg?style=for-the-badge&logo=dotnet&logoColor=white)
+
+### API - ALL IN !
+
+# Répartition du gitlab
+
+[**Sources**](Sources) : **Code de l'application**
+
+[**Documentation**](Documentation) : **Documentation de l'application**
+
+👉 [**Solution de l'application**](Sources/AllIn.sln)
+
+
+## Diagramme de classes du modèle
+
+```mermaid
+classDiagram
+class LargeImage{
+    +/Base64 : string
+}
+
+class User{
+    +/Name : string
+    +/Bio : string
+    +/Icon : string
+    +/Characteristics : Dictionary~string, int~
+    ~ AddSkin(skin : Skin) bool
+    ~ RemoveSkin(skin: Skin) bool
+    + AddSkill(skill: Skill) bool
+    + RemoveSkill(skill: Skill) bool
+    + AddCharacteristics(someCharacteristics : params Tuple~string, int~[])
+    + RemoveCharacteristics(label : string) bool
+    + this~label : string~ : int?
+}
+Champion --> "1" LargeImage : Image
+class ChampionClass{
+    <<enumeration>>
+    Unknown,
+    Assassin,
+    Fighter,
+    Mage,
+    Marksman,
+    Support,
+    Tank,
+}
+Champion --> "1" ChampionClass : Class
+class Skin{
+    +/Name : string    
+    +/Description : string
+    +/Icon : string
+    +/Price : float
+}
+Skin --> "1" LargeImage : Image
+Champion "1" -- "*" Skin 
+class Skill{
+    +/Name : string    
+    +/Description : string
+}
+class SkillType{
+    <<enumeration>>
+    Unknown,
+    Basic,
+    Passive,
+    Ultimate,
+}
+Skill --> "1" SkillType : Type
+Champion --> "*" Skill
+class Rune{
+    +/Name : string    
+    +/Description : string
+}
+Rune --> "1" LargeImage : Image
+class RuneFamily{
+    <<enumeration>>
+    Unknown,
+    Precision,
+    Domination
+}
+Rune --> "1" RuneFamily : Family
+class Category{
+    <<enumeration>>
+    Major,
+    Minor1,
+    Minor2,
+    Minor3,
+    OtherMinor1,
+    OtherMinor2
+}
+class RunePage{
+    +/Name : string
+    +/this[category : Category] : Rune?
+    - CheckRunes(newRuneCategory : Category)
+    - CheckFamilies(cat1 : Category, cat2 : Category) bool?
+    - UpdateMajorFamily(minor : Category, expectedValue : bool)
+}
+RunePage --> "*" Rune : Dictionary~Category,Rune~
+```
+
+
+
+<div align = right>
+<a rel="license" href="http://creativecommons.org/licenses/by-nc-nd/4.0/"><img alt="Licence Creative Commons" style="border-width:0" src="https://i.creativecommons.org/l/by-nc-nd/4.0/88x31.png" /></a>
+<right>
+
+</div>