Skip to content

Commit

Permalink
[DOCS] updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
teogor committed Jun 30, 2022
1 parent 63177ae commit 1dea66e
Show file tree
Hide file tree
Showing 9 changed files with 29 additions and 33 deletions.
2 changes: 1 addition & 1 deletion .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -1 +1 @@
github: [TeodorHMX1]
github: [teogor]
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ name: Bug report
about: Create a report to help us improve
title: "[Component name] Short description of issue"
labels: '@bug'
assignees: 'TeodorHMX1'
assignees: 'teogor'

---

Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ name: Feature request
about: Suggest an idea for this project
title: "[Component name] Short description of request"
labels: '@feature'
assignees: 'TeodorHMX1'
assignees: 'teogor'

---

Expand Down
12 changes: 4 additions & 8 deletions .zeobot/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,7 @@ zeobot:
# write down the users with access to restricted commands
listen_to:
users:
- TeodorHMX1
- Teogor
- teogor
# zeobot's features
features:
# if enabled, zeobot will post comments
Expand All @@ -36,11 +35,9 @@ auto_assign:
review_groups:
assignee_groups:
reviewers_to_add:
- TeodorHMX1
- Teogor
- teogor
assignees_to_add:
- TeodorHMX1
- Teogor
- teogor
skip_keywords:

# Autodelete Merged Branches (AMB)
Expand Down Expand Up @@ -77,8 +74,7 @@ enforce_branch_merge:
- main
# who has the right to write to protected branches
give_access_to:
- TeodorHMX1
- Teogor
- teogor

# License Checker (LC)
# branches that contains files without license will not be merged
Expand Down
2 changes: 1 addition & 1 deletion .zeobot/contributors.src
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
"repoHost": "https://github.com",
"contributors": [
{
"login": "TeodorHMX1",
"login": "teogor",
"name": "Teodor G.",
"avatar_url": "https://avatars.githubusercontent.com/u/22307006?v=4",
"profile": "http://team.zeoflow.com/teodor_g",
Expand Down
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,12 +26,12 @@ dependencies {
def memo_version = "x.y.z"
// Memo Library
implementation("com.zeoflow:memo:$memo_version")
implementation("com.zeoflow.memo:memo:$memo_version")
// Required if you want to use the injector
implementation("com.zeoflow:memo-annotation:$memo_version")
annotationProcessor("com.zeoflow:memo-compiler:$memo_version")
implementation("com.zeoflow.memo:memo-runtime:$memo_version")
annotationProcessor("com.zeoflow.memo:memo-compiler:$memo_version")
// For kotlin projects use kapt instead of annotationProcessor
kapt("com.zeoflow:memo-compiler:$memo_version")
kapt("com.zeoflow.memo:memo-compiler-ktx:$memo_version")
// ...
}
Expand Down Expand Up @@ -315,7 +315,7 @@ component.userProfile().usernameObserver((LifecycleOwner) this, new Observer<Str
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->
<p float="left">
<a href="docs/contributors.md#pushpin-teodor-g-teodorhmx1"><img width="100" src="https://avatars.githubusercontent.com/u/22307006?v=4" hspace=5 title='Teodor G. (@TeodorHMX1) - click for details about the contributions'></a>
<a href="docs/contributors.md#pushpin-teodor-g-teogor"><img width="100" src="https://avatars.githubusercontent.com/u/22307006?v=4" hspace=5 title='Teodor G. (@teogor) - click for details about the contributions'></a>
</p>

<!-- markdownlint-enable -->
Expand Down
26 changes: 13 additions & 13 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@ To use it:
```groovy
allprojects {
repositories {
mavenCentral()
mavenCentral()
}
}
}
```

3. Add the library to the `dependencies` section:
Expand All @@ -26,12 +26,12 @@ dependencies {
def memo_version = "x.y.z"
// Memo Library
implementation("com.zeoflow:memo:$memo_version")
implementation("com.zeoflow.memo:memo:$memo_version")
// Required if you want to use the injector
implementation("com.zeoflow:memo-annotation:$memo_version")
annotationProcessor("com.zeoflow:memo-compiler:$memo_version")
implementation("com.zeoflow.memo:memo-runtime:$memo_version")
annotationProcessor("com.zeoflow.memo:memo-compiler:$memo_version")
// For kotlin projects use kapt instead of annotationProcessor
kapt("com.zeoflow:memo-compiler:$memo_version")
kapt("com.zeoflow.memo:memo-compiler-ktx:$memo_version")
// ...
}
Expand Down Expand Up @@ -285,13 +285,13 @@ userProfile.addLoginListeners(new UserProfile_MemoEntity.LoginIOnChangedListener
Add observable for the username field
```java
component.userProfile().usernameObserver((LifecycleOwner) this, new Observer<String>()
{
@Override
public void onChanged(String username)
{
{
@Override
public void onChanged(String username)
{
// do something here
}
});
}
});
```

## License
Expand All @@ -315,7 +315,7 @@ component.userProfile().usernameObserver((LifecycleOwner) this, new Observer<Str
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->
<p float="left">
<a href="docs/contributors.md#pushpin-teodor-g-teodorhmx1"><img width="100" src="https://avatars.githubusercontent.com/u/22307006?v=4" hspace=5 title='Teodor G. (@TeodorHMX1) - click for details about the contributions'></a>
<a href="docs/contributors.md#pushpin-teodor-g-teogor"><img width="100" src="https://avatars.githubusercontent.com/u/22307006?v=4" hspace=5 title='Teodor G. (@teogor) - click for details about the contributions'></a>
</p>

<!-- markdownlint-enable -->
Expand Down
4 changes: 2 additions & 2 deletions docs/contributors.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@
<!-- markdownlint-disable -->
### :zap: Contributors List :zap:
<p float="left">
<a href="#pushpin-teodor-g-teodorhmx1"><img width="100" src="https://avatars.githubusercontent.com/u/22307006?v=4" hspace=5 title='Teodor G. (@TeodorHMX1) - click for details about the contributions'></a>
<a href="#pushpin-teodor-g-teogor"><img width="100" src="https://avatars.githubusercontent.com/u/22307006?v=4" hspace=5 title='Teodor G. (@teogor) - click for details about the contributions'></a>
</p>

---
### :pushpin: Teodor G. ([@TeodorHMX1](https://github.com/TeodorHMX1))
### :pushpin: Teodor G. ([@teogor](https://github.com/teogor))
#### Contributions:
- :bust_in_silhouette::computer: Code
- :open_book::pencil2: Documentation
Expand Down
2 changes: 1 addition & 1 deletion gradle.properties
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ android.nonTransitiveRClass=true
POM_NAME=Memo
POM_PACKAGING=aar
VERSION_NAME=1.3.0
GROUP=com.zeoflow
GROUP=com.zeoflow.memo
POM_DESCRIPTION=Android processing and secured library for managing SharedPreferences as key-value elements efficiently and structurally.
POM_URL=https://github.com/zeoflow/memo
POM_SCM_URL=https://github.com/zeoflow/memo
Expand Down

0 comments on commit 1dea66e

Please sign in to comment.