Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Sublimis authored Jun 10, 2024
1 parent 8f14545 commit 9de9d93
Showing 1 changed file with 8 additions and 9 deletions.
17 changes: 8 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# [Stilly](https://play.google.com/store/apps/details?id=com.sublimis.steadyscreen) screen stabilizer service for Android and Wear 🏝️
# [SteadyScreen](https://play.google.com/store/apps/details?id=com.sublimis.steadyscreen) service for Android and Wear 🏝️

### Make on-screen reading easier by softening small movements of mobile screens.

Expand All @@ -10,9 +10,9 @@ Ever been in a moving vehicle trying to read?
- It can improve screen readability and possibly alleviate motion sickness while on the go, e.g. while reading in a moving vehicle or walking.


## List of apps supporting Stilly service
## List of apps supporting SteadyScreen service

(as of 2024-03)
(as of 2024-05)

- [Wikipedia (developer build)](https://github.com/Sublimis/SteadyScreen/tree/main/wikipedia-android): We compiled this from [the original source](https://github.com/Sublimis/apps-android-wikipedia) on 2024-03-22. You are welcome to compile your own APK.

Expand All @@ -24,12 +24,11 @@ Ever been in a moving vehicle trying to read?

- The easiest way is to use the [SteadyViews](https://github.com/Sublimis/SteadyViews) library, which contains ready-to-use "Steady…" implementations of most common Android layouts (like e.g. LinearLayout or ConstraintLayout).
- Use the [SteadyView](https://github.com/Sublimis/SteadyView) library if you have a custom View or ViewGroup that you want to make compatible.
- Use the [SteadyService](https://github.com/Sublimis/SteadyService) library if you want to implement your own screen stabilizer service that won't need [Stilly](https://play.google.com/store/apps/details?id=com.sublimis.steadyscreen) to be installed.


## What happens if the service is not installed

Absolutely nothing. Your Views and ViewGroups continue to function as if the Stilly screen stabilizer service never existed, and we all get on with our merry lives.
Absolutely nothing. Your Views and ViewGroups continue to function as if the SteadyScreen service never existed, and we all get on with our merry lives.


## Enable or disable programatically
Expand Down Expand Up @@ -59,7 +58,7 @@ Call the `boolean ISteadyView.isSteadyViewEnabled()` on your ISteadyView to chec

## About the service

[Stilly](https://play.google.com/store/apps/details?id=com.sublimis.steadyscreen) application uses the [AccessibilityService API](https://developer.android.com/reference/android/accessibilityservice/AccessibilityService) to retrieve interactive windows on the screen, in order to find compatible ones. The service then sends multiple "move window" accessibility actions to such windows, as needed, to perform the intended function. The data accessed during the process, using Android's AccessibilityService API, can be of personal and confidential nature (i.e. sensitive information). The application never collects, stores nor shares that data in any way.
[SteadyScreen service](https://play.google.com/store/apps/details?id=com.sublimis.steadyscreen) application uses the [AccessibilityService API](https://developer.android.com/reference/android/accessibilityservice/AccessibilityService) to retrieve interactive windows on the screen, in order to find compatible ones. The service then sends multiple "move window" accessibility actions to such windows, as needed, to perform the intended function. The data accessed during the process, using Android's AccessibilityService API, can be of personal and confidential nature (i.e. sensitive information). The application never collects, stores nor shares that data in any way.

⚡ The service has been crafted very meticulously, in order to minimize resource usage and maximize performance. It uses only the accelerometer sensor to achieve the goal.

Expand All @@ -86,12 +85,12 @@ Also, translators are rewarded with free app licenses. Please [contact us via em

## History

The technology behind the Stilly first appeared in our [Urban Biker](https://urban-bike-computer.com/) app in late 2022. It took us a while to realize it was cool enough to release it as a separate semi-open source project.
The technology behind the SteadyScreen first appeared in our [Urban Biker](https://urban-bike-computer.com/) app in late 2022. It took us a while to realize it was cool enough to release it as a separate semi-open source project.


## Project components

- [Stilly app](https://play.google.com/store/apps/details?id=com.sublimis.steadyscreen): The engine behind the scenes.
- [SteadyService library](https://github.com/Sublimis/SteadyService): If you want to implement your own screen stabilizer service that won't need Stilly.
- [SteadyScreen service app](https://play.google.com/store/apps/details?id=com.sublimis.steadyscreen): The engine behind the scenes.
- [SteadyViews library](https://github.com/Sublimis/SteadyViews): Ready-to-use "Steady…" implementations of most common Android layouts (like e.g. LinearLayout or ConstraintLayout).
- [SteadyView library](https://github.com/Sublimis/SteadyView): Core classes and methods. To be used for custom View or ViewGroup implementations.
- [SteadyService library](https://github.com/Sublimis/SteadyService): Details of the service implementation.

0 comments on commit 9de9d93

Please sign in to comment.