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.

Sign up for GitHub

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

Jump to bottom

Add README documentation for modules #50

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

Add README documentation for modules #50

wants to merge 1 commit into from

Conversation

mrylmz
Copy link
Contributor

@mrylmz mrylmz commented Jul 1, 2021

Resolves #32

JensK611
JensK611 reviewed Jul 6, 2021
View reviewed changes
Modules/Keychain/README.md

```swift
struct MyDataRepository {
@Secured(key: "<#keychain value identifier#>")
Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe we could add an example for the full usage, together with passing the keychain instance

Modules/UserDefaults/README.md

```swift
struct MyDataRepository {
@UserDefault(key: "<#value identifier#>", defaultValue: true)
Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe you could adjust the example in the way that a user defaults instance can be passed.

@mrylmz
Copy link
Contributor Author

mrylmz commented Jul 6, 2021

@JensK611 It makes sense to add additional advanced documentation but as for now I would delay it for a future improvement.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@JensK611 JensK611 JensK611 left review comments

@smnbck smnbck Awaiting requested review from smnbck

@rocklyve rocklyve Awaiting requested review from rocklyve

@fredpi fredpi Awaiting requested review from fredpi

@jamitJona jamitJona Awaiting requested review from jamitJona

@jjorn jjorn Awaiting requested review from jjorn

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Add readme files for modules
2 participants
@mrylmz @JensK611