aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorOxbian <oxbian@mailbox.org>2024-10-13 14:20:48 -0400
committerOxbian <oxbian@mailbox.org>2024-10-13 14:20:48 -0400
commit633bf74a3ecb66760010ce8b958356523bd75a4b (patch)
treeadacecbfc335931966254c50f997b37b66b9c763 /README.md
downloadweb-template-633bf74a3ecb66760010ce8b958356523bd75a4b.tar.gz
web-template-633bf74a3ecb66760010ce8b958356523bd75a4b.zip
Init: readme + license
Diffstat (limited to 'README.md')
-rw-r--r--README.md30
1 files changed, 30 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..5befa2d
--- /dev/null
+++ b/README.md
@@ -0,0 +1,30 @@
+# Bootstrap ArKa
+---
+
+This repo contains some templates (sidebar, modal, caroussel, ...) that could be used for your website or project.
+All templates and components are made in pure **HTML & CSS**, and they all follow W3C standards.
+
+I use this website template and components in my websites and projects for [ArKa](https://arka.rocks/).
+
+## Installation
+
+```
+git clone https://git.arka.rocks/ArKa/templates-ArKa.git
+```
+
+## Utilisation
+
+I don't recommand to import the project, but to just import the `default.css` file which define all the colors and basic website settings, and after that import manually the components CSS you need.
+
+### Components
+
+The following components are available:
+- buttons
+- dropdowns
+- inputfields
+- quotes
+- codes
+
+## License
+
+This project is under [GPL-v3](https://git.arka.rocks/ArKa/web-template/src/branch/main/COPYING), basically you can use it, share it, modify it, but it needs to be under the same license (GPLv3) or a compatible one.
ArKa projects. All rights to me, and your next child right arm.