readme - examples and contributing section added

spilymp · Apr 8, 2022 · 927a071 · 927a071
1 parent 6096201
commit 927a071
Show file tree

Hide file tree

Showing 7 changed files with 17 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1,11 +1,21 @@
 # IBO - Icon Builder for Odoo
 
+## Examples
+![Odoo 15 Example Icon "Drop" from Bootstrap](examples\icon_bootstrap.png)
+![Odoo 15 Example Icon "Drop" from Bootstrap](examples\icon_fontawesome.png)
+![Odoo 15 Example Icon "Drop" from Bootstrap](examples\icon_remix.png)
+![Odoo 15 Example Icon "Drop" from Bootstrap](examples\icon_simple.png)
+![Odoo 15 Example Icon "Drop" from Bootstrap](examples\icon_tabler.png)
+![Odoo 15 Example Icon "Drop" from Bootstrap](examples\icon_weather.png)
+
+## Getting started
+
 The provided [Configurator](https://spilymp.github.io/ibo/) can be used to quickly and easily create new appicons in the style of the
 appicons of the ERP system [Odoo](https://www.odoo.com/).
 
 But it is also possible to use the included js class elsewhere and create your own configurator based on it, for example.
 
-For this purpose, the class offers a few more parameters for individualization in addition to the options shown in the documentation section.
+For this purpose, the class offers a few more parameters for individualization in addition to the options explained in the documentation section.
 
 ## Documentation
 
@@ -14,3 +24,9 @@ If the existing class is used directly by means of a script, additional paramete
 If this class is instantiated, various parameters can be passed to it.
 If not, default values are used in each case.
 For more information please visit the [Project Website](https://spilymp.github.io/ibo/).
+
+## Contributing
+Everyone is welcome to extend the icon generator, fix bugs or add new functionalities. So feel free to open a discussion in an issue or create a pull request with your idea. 
+If you encounter a bug or problem, please also create an issue so that I or another kind person can solve the problem.
+
+**Note**: This is a private project that I maintain in my spare time. Accordingly, I apologize in advance for late reactions or responses to your submissions or issues. Furthermore, I have certain ideas about functionality and design. Changes that I don't "like" will not be implemented, sorry! So feel free to present your idea to me first, before you implement it.
diff --git a/examples/icon_bootstrap.png b/examples/icon_bootstrap.png
diff --git a/examples/icon_fontawesome.png b/examples/icon_fontawesome.png
diff --git a/examples/icon_remix.png b/examples/icon_remix.png
diff --git a/examples/icon_simple.png b/examples/icon_simple.png
diff --git a/examples/icon_tabler.png b/examples/icon_tabler.png
diff --git a/examples/icon_weather.png b/examples/icon_weather.png