Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

README Update #93

Open
wants to merge 8 commits into
base: dev
Choose a base branch
from
Open

README Update #93

wants to merge 8 commits into from

Conversation

Sanlorng
Copy link
Collaborator

@Sanlorng Sanlorng commented Dec 7, 2024

  • Update implemented controls section.
  • Add Credits section.
  • Add Snapshot introduction.
  • Add Supported Kotlin Target section.
  • Add Contribution section.

This commit adds a badge for the snapshot version to the README file.

It also includes a description on how to use the snapshot version by adding the snapshot maven repository.
This commit adds a new section to the README file acknowledging the open-source projects and libraries that this project depends on.

The credits section is organized into three categories: Fluent, Fluent-Icons, and Gallery. Each category lists the projects, their descriptions, and their respective licenses.

This addition aims to recognize and express gratitude to the developers and maintainers of these projects for their contributions to the open-source community.
This commit updates the README file to reflect the implementation of several new Fluent UI components, including:

**Basic Controls:**

- Pill Button
- Segmented Button
- Lite Filter
- List Item

**Compound Components:**

- TopNav
- NavigationView
- BreadcrumbBar
- TabView
- Tooltip
- MenuFlyout (Simple)
- Expander
- CommandBar
- CommandBarFlyout
- AutoSuggestBox
This commit adds a table to the README file listing the supported Kotlin targets and their corresponding platforms. This information helps users understand which platforms the library is compatible with.
@Sanlorng Sanlorng requested review from Konyaco and 123Duo3 December 7, 2024 04:07
This commit introduces a comprehensive contribution guide for the project.

The guide outlines the following:

- **Getting Started:**  Instructions on forking the repository, branching, and development workflow.
- **Developing Components:** Guidance on creating components, handling internal classes, and adhering to design guidelines.
- **Testing and Showcasing Components:** Steps for adding component examples to the Gallery app using KSP and KotlinPoet.
- **Need Help:** Resources and support channels for contributors.

This contribution aims to streamline the contribution process and ensure consistency in component development and documentation.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant