diff --git a/README.md b/README.md index bfc1d4a..ec334a2 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,34 @@ # devil-fruit-encyclopedia An encyclopedia about One Piece devil fruits build with HTML, CSS and JS + +[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT) +[![Status](https://img.shields.io/badge/Status-Beta-red.svg)](https://en.wikipedia.org/wiki/Software_release_life_cycle#Beta) + +# About +A simple and small encyclopedia about the One Piece devil fruits built with HTML, CSS and JS. +SPOILER-WARNING: THIS WEBSITE WILL SPOILER MANY FRUITS ASWELL AS DETAILS RELATED TO EACH FRUIT! VISIT AT YOUR OWN RISK!! + +# Requirements +- `Web-Browser`: Firefox (recommended), Chrome / Chromium, Safari (if on MacOS) +- `JavaScript`: enabled +- `Internet`: active connection + +# Usage +- View fruits: Users can view existing fruits (f. e. the "gomu gomu no mi", the Gum-Gum fruit) +- Add fruits: Users can add fruits (f. e. the "bara bara no mi", Chop-Chop fruit) +- Update fruits: Users can update fruits (those they added themself) to add / remove details +- Delete fruits: Users can delete fruits they added + +# Supported OS +- Linux, MacOS, FreeBSD, Windows, Android, iOS + +# Access +1. (To be added) + +# License and Credits +**Author**: [Cametendo](https://www.github.com/Cametendo) +**License**: MIT + +## Note +This is just a small school project. Because of that, I don't know if I'll continue after presenting the end result +- Cametendo