Skip to content

A Compose Desktop library for managing preferences and settings based off of Java's Preferences API

License

Notifications You must be signed in to change notification settings

MaleficCompose/MaleficPrefs

Repository files navigation

MaleficPrefs

Maven Central Version

A Compose Desktop library for managing preferences and settings based on Java's Preferences API

🦿 Prerequisites

  • Java 21 or above
  • Kotlin 2.1.0

⌨️ Usage

  1. Get the artifact from the central repo
  2. Use either the Property Delegate classes from xyz.malefic.compose.prefs.delegate package or the Persistent Collection types from xyz.malefic.compose.prefs.collection
  3. Read the documentation for more details

🏗 Project Status

Under construction

✍️ Author

👤 Om Gupta

Feel free to reach out 【ツ】

🤝 Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Open an issue first to discuss what you would like to change.
  2. Fork the Project
  3. Create your feature branch (git checkout -b feature/amazing-feature)
  4. Commit your changes (git commit -m 'Add some amazing feature')
  5. Push to the branch (git push origin feature/amazing-feature)
  6. Open a pull request

Please make sure to update tests as appropriate.

❤ Show your support

Give a ⭐️ if this project helped you!

📝 License

MIT License

Copyright (c) 2024 Om Gupta

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

This README was generated by readgen

About

A Compose Desktop library for managing preferences and settings based off of Java's Preferences API

Resources

License

Stars

Watchers

Forks

Packages

No packages published