Skip to content

Drag0ndust/DragonAnnouncement

Repository files navigation

DragonAnnouncement

Static Badge GitHub last commit (branch) GitHub Workflow Status (with event)

Welcome to the DragonAnnouncement Swift Package. Use this package to show announcements in your app from a local source in the app or from a remote source from the web.

Getting started

Add DragonAnnouncement to your Package.swift dependencies

dependencies: [
    ...
    .package(url: "https://github.com/Drag0ndust/DragonAnnouncement", from: "1.0.0"),
    ...
]

Usage

The package provides a ViewModifier called .announcement(type:) which can be added to each SwiftUI View.

VStack {
    Text("Example App")
}
.announcement(type: .local(announcement: exampleAnnouncement))

For a complete example, refer to the ExampleApp directory in the project repository.

Contribution

  • Read the Code of Conduct
  • Read the Contribution Guidelines
  • Create a new issue or work on an existing issue (check if someone is already assigned first).
  • Feel free to extend the functionality, but ensure your change benefits all users of this package.

Support

You can sponsor me on Github Sponsors to support my open-source projects.

Contact

Feel free to reach out if you have questions or if you want to contribute in any way:

License

This project is licensed under MIT.