update readme

README.md

@@ -1,2 +1,85 @@
-# swagger-ui-themes
-Themes for swagger-ui
+# <img src="./images/swagger-ui-themes-logo.png" width="100">
+# Swagger UI Themes
+
+## Introduction
+Themes are a powerful addition to any user interface, and for Swagger UI, they bring a range of benefits that enhance both the developer experience and the end-user interaction.
+
+### Why Themes Matter for Swagger UI
+Swagger UI is a popular framework for generating beautiful, interactive documentation for APIs. While it excels at presenting structured data, the visual experience often remains generic and may not align with the unique branding and stylistic preferences of different projects or companies. This is where themes come into play.
+
+Tailored User Experience
+Themes allow you to tailor the look and feel of your API documentation to match your company's branding. By customizing colors, fonts, and layout, you can create a seamless experience for users who navigate between your documentation and your main website or application.
+
+### Improved Readability
+Good theming enhances readability and user engagement. With themes, you can adjust the contrast, spacing, and typography to improve clarity and make your documentation more accessible to a wider audience, including those with visual impairments.
+
+### Personalization
+Developers and users alike enjoy personalization. Themes give them the power to choose how they interact with your API documentation. Whether they prefer a light theme for a bright environment or a dark theme for late-night coding sessions, offering multiple themes can improve the overall user experience.
+
+### Brand Consistency
+For businesses, maintaining brand consistency across all platforms and tools is crucial. Themes ensure that your API documentation is not only functional but also a natural extension of your brand identity.
+
+### Stand Out in the Crowd
+In a sea of default-styled documentation, a custom-themed Swagger UI can make your API stand out. It helps to make a strong visual impression that can attract and retain developers' attention.
+
+By embracing themes for Swagger UI, you can provide a more engaging, accessible, and consistent experience for everyone who uses your API documentation.
+
+
+
+## Compatibility
+Swagger UI Themes is currerntly compatable with Swagger UI [v5.0.0](https://github.com/swagger-api/swagger-ui/tree/v5.0.0)
+
+## Documentation
+WIP
+
+### Browser support
+Swagger UI Themes works in the latest versions of Chrome, Safari, Firefox, and Edge.
+
+# Contributing
+
+We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:
+
+- Reporting a bug
+- Discussing the current state of the code
+- Submitting a fix
+- Proposing new features
+- Becoming a maintainer
+
+## Pull Requests
+
+Pull requests are the best way to propose changes to the codebase. We actively welcome your pull requests:
+
+1. Fork the repo and create your branch from `main`.
+2. If you've added code that should be tested, add tests.
+3. If you've changed APIs, update the documentation.
+4. Ensure the test suite passes.
+5. Make sure your code lints.
+6. Issue that pull request!
+
+## Any contributions you make will be under the same [license](LICENSE.md) as this project
+
+As our project is licensed under [Apache 2.0 license](LICENSE.md), any contributions are understood to be under the same license.
+
+## Report bugs using Github's [issues](https://github.com/jcphlux/swagger-ui-themes/issues)
+
+We use GitHub issues to track public bugs. Report a bug by [opening a new issue](https://github.com/jcphlux/swagger-ui-themes/issues/new); it's that easy!
+
+## Write bug reports with detail, background, and sample code
+
+**Great Bug Reports** tend to have:
+
+- A quick summary and/or background
+- Steps to reproduce
+  - Be specific!
+  - Give sample code if you can.
+- What you expected would happen
+- What actually happens
+- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)
+
+People *love* thorough bug reports.
+
+## License
+
+By contributing, you agree that your contributions will be licensed under its [Apache 2.0 license](LICENSE.md).
+Swagger UI Themes comes with an explicit [NOTICE](NOTICE) file
+containing additional legal notices and information.