Browse Source

Update README.md to include project title, description, features, installation instructions, contributing guidelines, and license information. Add data privacy section and application logo.

Carles Sentis 3 days ago
parent
commit
4576d2f651
1 changed files with 38 additions and 16 deletions
  1. 38 16
      README.md

+ 38 - 16
README.md

@@ -1,27 +1,49 @@
-# Project Title
+![logo](app/src/main/res/mipmap-xxxhdpi/ic_launcher.webp)
 
-A brief description of what this project does and who it's for.
+# Public Pool Android
 
-## Installation
-
-Instructions on how to install the project or dependencies.
-
-```bash
-# Example installation command
-```
+Monitor your cryptocurrency mining activity on Public Pool directly from your Android device. Keep track of your hash rate, workers, and wallet details on the go.
 
-## Usage
+## Features
 
-How to use the project. Provide examples or code snippets.
+*   **Dashboard:** View your overall mining statistics, including best difficulty, network difficulty, network hash rate, block height, and hash rate history.
+*   **Workers:** Monitor the status of your individual mining workers, including their hash rate, difficulty, and last seen time.
+*   **Wallet:** Check your wallet balance, transaction history, and the current price of the mined currency.
 
-```python
-# Example usage
-```
+## Installation
 
 ## Contributing
 
-Information on how to contribute to the project.
+Contributions are welcome! Please feel free to submit pull requests or open issues on the project repository:
+
+[https://repo.codeskraps.com/codeskraps/PublicPoolAndroid](https://repo.codeskraps.com/codeskraps/PublicPoolAndroid)
 
 ## License
 
-Specify the project license. 
+```
+MIT License
+
+Copyright (c) 2025 [codeskraps]
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+```
+
+## Data Privacy
+
+This application collects and uses data as described in the [Privacy Policy](privacy_policy.md).