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

Update README about Kotlin DSL support #8

Merged
merged 1 commit into from
Jan 1, 2023

Conversation

icepeppermint
Copy link
Contributor

Motivation:

Regarding Kotlin DSL support, we finally have the conditional-kotlin module available. Therefore, it is necessary to update the README.

Modifications:

  • Added the Kotlin DSL support from the README
  • Removed the Spring integration from the README
  • Added Contributors to README

Result:

  • We can introduce that we can get support for the Kotlin DSL through the conditional-kotlin dependency.

@icepeppermint icepeppermint added the documentation Improvements or additions to documentation label Jan 1, 2023
@icepeppermint icepeppermint added this to the conditional-kotlin milestone Jan 1, 2023
@icepeppermint icepeppermint self-assigned this Jan 1, 2023
@icepeppermint
Copy link
Contributor Author

@doljae Could you review this PR?? From now on, we can finally use the conditional-kotlin dependency!

Comment on lines -181 to -183
## Easy to integrate with Spring Framework
## Kotlin DSL support
If you are using the [Kotlin programming language](https://kotlinlang.org), try to use _Conditional-Kotlin_. It makes it easier for you to make conditional expressions using the Kotlin DSL.

If you are using [Spring Framework](https://spring.io/projects/spring-framework), you can also make conditional expressions like this:
Copy link
Contributor

@doljae doljae Jan 1, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there a reason for removing usage-related things from Spring Framework?

If the intention is to leave only the contents of the conditional project itself in the README, it would be nice to mention the examples module.

This seems to have the effect of naturally leading users to modules containing use cases 🙂

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As you know, Conditional can be used in various JVM-based environments.
But if the README mentions Spring Framework, it might seem that Conditional is good to use only in Spring Framework. So, it is better not to specify the environment in which Conditional can be used.

As you said, it would be nice to mention in the README about the examples module and it would be nice to think about where and how to add this. Thank you for your review. 👍

Copy link
Contributor

@doljae doljae left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@icepeppermint icepeppermint merged commit 1b64816 into main Jan 1, 2023
@icepeppermint icepeppermint deleted the readme-kotlin-dsl-support branch January 1, 2023 08:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants