Skip to content

Commit e84c541

Browse files
FredHappyfaceFredHappyface
committed
update project readme
1 parent 61c8091 commit e84c541

1 file changed

Lines changed: 66 additions & 104 deletions

File tree

‎README.md‎

Lines changed: 66 additions & 104 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
1+
2+
<img src="metadata/en-US/images/featureGraphic.png" alt="Feature Graphic" width="">
3+
14
[![GitHub top language](https://img.shields.io/github/languages/top/FredHappyface/Android.EweSticker.svg?style=for-the-badge)](../../)
2-
[![Repository size](https://img.shields.io/github/repo-size/FredHappyface/Android.EweSticker.svg?style=for-the-badge)](../../)
35
[![Issues](https://img.shields.io/github/issues/FredHappyface/Android.EweSticker.svg?style=for-the-badge)](../../issues)
46
[![License](https://img.shields.io/github/license/FredHappyface/Android.EweSticker.svg?style=for-the-badge)](/LICENSE.md)
57
[![Commit activity](https://img.shields.io/github/commit-activity/m/FredHappyface/Android.EweSticker.svg?style=for-the-badge)](../../commits/master)
@@ -9,53 +11,46 @@
911
<!-- omit in toc -->
1012
# Android.EweSticker
1113

12-
<img src="metadata/en-US/images/featureGraphic.png" alt="Feature Graphic" width="750">
13-
14-
Sticker-board for android inspired by uSticker (forked from woosticker).
14+
EweSticker is an Android sticker keyboard application, specifically designed for sharing a wide variety of custom stickers in supported messaging apps. This project draws inspiration from the uSticker project and is a fork of the woosticker repository.
1515

1616
- [Features](#features)
1717
- [Screenshots](#screenshots)
1818
- [Documentation](#documentation)
19+
- [Installation](#installation)
1920
- [Gradle tasks](#gradle-tasks)
20-
- [Language Information](#language-information)
21-
- [Kotlin and Android Version](#kotlin-and-android-version)
22-
- [Download Android Studio](#download-android-studio)
23-
- [How to Run](#how-to-run)
24-
- [Build From Source](#build-from-source)
25-
- [Get it on F-Droid](#get-it-on-f-droid)
26-
- [Get it on Google Play](#get-it-on-google-play)
27-
- [Download the APK](#download-the-apk)
28-
- [Download Project](#download-project)
29-
- [Clone](#clone)
21+
- [Kotlin and Android Version](#kotlin-and-android-version)
22+
- [Building From Source](#building-from-source)
23+
- [Git Clone](#git-clone)
3024
- [Using The Command Line](#using-the-command-line)
3125
- [Using GitHub Desktop](#using-github-desktop)
32-
- [Download Zip File](#download-zip-file)
26+
- [(or) Download Zip File](#or-download-zip-file)
27+
- [Download Android Studio](#download-android-studio)
3328
- [Community Files](#community-files)
3429
- [Licence](#licence)
3530
- [Changelog](#changelog)
3631
- [Code of Conduct](#code-of-conduct)
3732
- [Contributing](#contributing)
3833
- [Security](#security)
3934
- [Support](#support)
40-
- [Rationale](#rationale)
35+
- [Development Info](#development-info)
4136

4237
## Features
4338

44-
- Wide range of custom stickers supported
45-
- image/gif
46-
- image/png
47-
- image/webp
48-
- image/jpeg
49-
- image/heif
50-
- video/3gpp
51-
- video/mp4
52-
- video/x-matroska
53-
- video/webm
54-
- Send stickers in supported apps (image/png is used as a fallback)
55-
- Vertical and Horizontal scrolling
56-
- Change number of rows and sticker preview size
57-
- Ties in with the system theme
58-
- Long press on a sticker to show a preview
39+
The EweSticker Android app offers the following key features to enhance your messaging experience:
40+
41+
- **Wide Range of Custom Stickers Supported**: EweSticker supports a diverse set of sticker formats, ensuring that users can share their creativity in various ways. Supported formats include image/gif, image/png, image/webp, image/jpeg, image/heif, video/3gpp, video/mp4, video/x-matroska, and video/webm.
42+
43+
- **Seamless Sticker Sharing**: Users can easily send stickers within messaging apps that support custom media sharing using image/png as a fallback.
44+
45+
- **Customizable Scrolling**: The app offers both vertical and horizontal scrolling options, enabling users to navigate through their sticker collection according to their preferred orientation.
46+
47+
- **Sticker Preview Customization**: Users have the freedom to adjust the number of rows and the sticker preview size, tailoring the viewing experience to their liking and device screen dimensions.
48+
49+
- **Integration with System Theme**: EweSticker seamlessly integrates with the system's theme, ensuring that the app's appearance aligns with the user's device-wide design choices.
50+
51+
- **Sticker Preview on Long Press**: To facilitate sticker selection, users can long-press on a sticker to reveal a preview. This feature helps users quickly decide which sticker they want to share without the need to open the sticker collection separately.
52+
53+
EweSticker brings a wide range of customization options, diverse format support, and integration with messaging apps. Whether users are sharing static images, animated GIFs, or even short videos, the app aims to provide an engaging and expressive way to communicate using custom stickers.
5954

6055
## Screenshots
6156

@@ -81,79 +76,40 @@ where to look for certain things:
8176
- The [Help](/documentation/help) guide provides a starting point and outlines common issues that you
8277
may have.
8378

84-
## Gradle tasks
79+
## Installation
8580

86-
- ktlintCheck (`gradlew ktlintCheck`): run ktlint over the codebase
87-
- genDocs (`gradlew genDocs`): generate the api reference using dokka
81+
You can install the app using the following methods, Follow the link to the listing on your
82+
preferred store by clicking on one of the badges below, then download/install:
8883

89-
## Language Information
84+
[<img src="readme-assets/badges/f-droid-download.png" alt="Get it on F-Droid" height="80">](https://f-droid.org/en/packages/com.fredhappyface.ewesticker/)
85+
[<img src="readme-assets/badges/google-play-download.png" alt="Get it on Google Play" height="80">](https://play.google.com/store/apps/details?id=com.fredhappyface.ewesticker)
86+
[<img src="readme-assets/badges/direct-apk-download.png" alt="Direct apk download" height="80">](../../releases)
9087

91-
### Kotlin and Android Version
88+
<!-- omit in toc -->
89+
### Build from Source
9290

93-
This app has been written in Kotlin 1.5.0 with the Android Studio IDE.
91+
Follow the steps in [Building from Source](link_to_building_from_source) section.
9492

95-
- The target SDK version is 31 (Android 12)
96-
- The minimum SDK version is 26 (Android 8 Oreo)
93+
## Gradle tasks
9794

98-
#### Download Android Studio
95+
- ktlintCheck (`gradlew ktlintCheck`): run ktlint over the codebase
96+
- genDocs (`gradlew genDocs`): generate the api reference using dokka
9997

100-
Download the Android Studio IDE from <https://developer.android.com/studio/>.
101-
For Windows, double click the downloaded .exe file and follow the instructions
102-
provided by the installer - it will download the Android emulator and the
103-
Android SDK. Additional information can be found at
104-
<https://developer.android.com/studio/install>
98+
## Kotlin and Android Version
99+
100+
This app has been written in Kotlin 1.9.0 with the Android Studio IDE.
105101

106-
## How to Run
102+
- The target SDK version is 33 (Android 13)
103+
- The minimum SDK version is 26 (Android 8 Oreo)
107104

108-
### Build From Source
105+
## Building From Source
109106

110107
1. Download or clone this GitHub repository
111108
2. (If downloaded) Extract the zip archive
112109
3. In Android Studio click File > Open and then navigate to the project file
113110
(Android studio defaults to the directory of the last opened file)
114111

115-
### Get it on F-Droid
116-
117-
1. Open the F-Droid app
118-
2. Search for EweSticker
119-
120-
or
121-
122-
[<img src="readme-assets/badges/f-droid-download.png"
123-
alt="Get it on F-Droid" height="80">](https://f-droid.org/en/packages/com.fredhappyface.ewesticker/)
124-
125-
Follow the link to the listing on F-Droid by clicking on the badge above,
126-
then download/ install
127-
128-
### Get it on Google Play
129-
130-
1. Open the Google Play app
131-
2. Search for EweSticker
132-
133-
or
134-
135-
[<img src="readme-assets/badges/google-play-download.png"
136-
alt="Get it on Google Play" height="80">](https://play.google.com/store/apps/details?id=com.fredhappyface.ewesticker)
137-
138-
Follow the link to the listing on Google Play by clicking on the badge above,
139-
then download/ install
140-
141-
### Download the APK
142-
143-
1. For releases, navigate to the releases page [here](../../releases).
144-
2. Select the debug or release APK depending on your preference. Note that the
145-
filenames are in the form: com.fredhappyface.ewesticker-(version)-(debug|release).apk
146-
147-
or
148-
149-
[<img src="readme-assets/badges/direct-apk-download.png" alt="Direct apk
150-
download" height="80">](../../releases)
151-
152-
Navigate to the releases page by clicking on the badge above.
153-
154-
## Download Project
155-
156-
### Clone
112+
### Git Clone
157113

158114
#### Using The Command Line
159115

@@ -179,12 +135,20 @@ https://help.github.com/en/articles/cloning-a-repository
179135
More information can be found at
180136
https://help.github.com/en/desktop/contributing-to-projects/cloning-a-repository-from-github-to-github-desktop
181137

182-
### Download Zip File
138+
### (or) Download Zip File
183139

184140
1. Download this GitHub repository
185141
2. Extract the zip archive
186142
3. Copy/ move to the desired location
187143

144+
### Download Android Studio
145+
146+
Download the Android Studio IDE from <https://developer.android.com/studio/>.
147+
For Windows, double click the downloaded .exe file and follow the instructions
148+
provided by the installer - it will download the Android emulator and the
149+
Android SDK. Additional information can be found at
150+
<https://developer.android.com/studio/install>
151+
188152
## Community Files
189153

190154
### Licence
@@ -198,35 +162,33 @@ See the [Changelog](/CHANGELOG.md) for more information.
198162

199163
### Code of Conduct
200164

201-
Online communities include people from many backgrounds. The *Project*
202-
contributors are committed to providing a friendly, safe and welcoming
203-
environment for all. Please see the
165+
Our project welcomes individuals from diverse backgrounds and perspectives.
166+
We are committed to providing a friendly, safe and welcoming environment for all. Please see the
204167
[Code of Conduct](https://github.com/FredHappyface/.github/blob/master/CODE_OF_CONDUCT.md)
205-
for more information.
168+
for more information.
206169

207170
### Contributing
208171

209-
Contributions are welcome, please see the
172+
Your contributions are valuable and help improve the project for everyone, please see the
210173
[Contributing Guidelines](https://github.com/FredHappyface/.github/blob/master/CONTRIBUTING.md)
211174
for more information.
212175

213176
### Security
214177

215-
Thank you for improving the security of the project, please see the
216-
[Security Policy](https://github.com/FredHappyface/.github/blob/master/SECURITY.md)
178+
If you discover a security vulnerability, we appreciate your responsible disclosure. Please see the
179+
[Security Policy](https://github.com/FredHappyface/.github/blob/master/.github/SECURITY/SECURITY.md)
217180
for more information.
218181

219182
### Support
220183

221-
Thank you for using this project, I hope it is of use to you. Please be aware that
222-
those involved with the project often do so for fun along with other commitments
223-
(such as work, family, etc). Please see the
184+
Thank you for using this project, I hope it is of use to you. Please keep in mind that
185+
the folks working on this project are enthusiasts with various commitments such as work,
186+
family, and other passions. See the
224187
[Support Policy](https://github.com/FredHappyface/.github/blob/master/SUPPORT.md)
225188
for more information.
226189

227-
### Rationale
190+
### Development Info
228191

229-
The rationale acts as a guide to various processes regarding projects such as
230-
the versioning scheme and the programming styles used. Please see the
231-
[Rationale](https://github.com/FredHappyface/.github/blob/master/RATIONALE.md)
192+
Serves as a guide to various aspects of project development, including versioning, style guidelines, and recommended practices. Please see the
193+
[Rationale](https://github.com/FredHappyface/.github/blob/master/DEVELOPMENT_INFO.md)
232194
for more information.

0 commit comments

Comments
 (0)