Skip to content

Commit

Permalink
update project details
Browse files Browse the repository at this point in the history
  • Loading branch information
Zzombiee2361 committed Apr 28, 2022
1 parent 5a0f983 commit 3a60626
Show file tree
Hide file tree
Showing 3 changed files with 31 additions and 28 deletions.
3 changes: 2 additions & 1 deletion .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
patreon: cstayyab
patreon: Zzombiee2361
liberapay: Zzombiee2361
custom: https://www.linux-apps.com/p/1383431/
51 changes: 27 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,34 +1,41 @@
<p align="center">
<img src="https://socialify.git.ci/cstayyab/WALC/image?description=1&font=Bitter&forks=1&logo=https%3A%2F%2Fgithub.com%2Fcstayyab%2FWALC%2Fraw%2Fmaster%2Fsrc%2Ficons%2Flogo360x360.png&pattern=Floating%20Cogs&stargazers=1&theme=Dark" alt="WALC" width="640" height="320" />
<img src="https://socialify.git.ci/WAClient/WALC/image?description=1&font=Bitter&forks=1&logo=https%3A%2F%2Fgithub.com%2FWAClient%2FWALC%2Fraw%2Fmaster%2Fsrc%2Ficons%2Flogo360x360.png&pattern=Floating%20Cogs&stargazers=1&theme=Dark" alt="WALC" width="640" height="320" />
</p>
<h1 align="center">WALC - WhatsApp Linux Client (unofficial)</h1>
<p align="center">

![Contributors List](https://img.shields.io/badge/dynamic/json?label=Contributors&query=%24..login&url=https%3A%2F%2Fapi.github.com%2Frepos%2Fcstayyab%2FWALC%2Fcontributors) ![GitHub release (latest by date)](https://img.shields.io/github/v/release/cstayyab/WALC?color=%2325D366&label=Latest%20Release) ![GitHub Releases (by Release)](https://img.shields.io/github/downloads/cstayyab/WALC/latest/total?color=%2325D366&label=Latest%20Version%20AppImage%20Downloads&logo=Linux&logoColor=%23FFFFFF) [![GitHub issues](https://img.shields.io/github/issues/cstayyab/WALC.svg)](https://github.com/cstayyab/WALC/issues) [![GitHub forks](https://img.shields.io/github/forks/cstayyab/WALC.svg)](https://github.com/cstayyab/WALC/network) [![GitHub stars](https://img.shields.io/github/stars/cstayyab/WALC.svg)](https://github.com/cstayyab/WALC/stargazers) [![GitHub license](https://img.shields.io/github/license/cstayyab/WALC.svg)](https://github.com/cstayyab/WALC/blob/master/LICENSE) [![Twitter](https://img.shields.io/twitter/url/https/github.com/cstayyab/WALC.svg?style=social)](https://twitter.com/intent/tweet?text=Wow:&url=https%3A%2F%2Fgithub.com%2Fcstayyab%2FWALC) [![walc](https://snapcraft.io//walc/badge.svg)](https://snapcraft.io/walc) [![walc](https://snapcraft.io//walc/trending.svg?name=0)](https://snapcraft.io/walc)
![Contributors List](https://img.shields.io/badge/dynamic/json?label=Contributors&query=%24..login&url=https%3A%2F%2Fapi.github.com%2Frepos%2FWAClient%2FWALC%2Fcontributors) ![GitHub release (latest by date)](https://img.shields.io/github/v/release/WAClient/WALC?color=%2325D366&label=Latest%20Release) ![GitHub Releases (by Release)](https://img.shields.io/github/downloads/WAClient/WALC/latest/total?color=%2325D366&label=Latest%20Version%20AppImage%20Downloads&logo=Linux&logoColor=%23FFFFFF) [![GitHub issues](https://img.shields.io/github/issues/WAClient/WALC.svg)](https://github.com/WAClient/WALC/issues) [![GitHub forks](https://img.shields.io/github/forks/WAClient/WALC.svg)](https://github.com/WAClient/WALC/network) [![GitHub stars](https://img.shields.io/github/stars/WAClient/WALC.svg)](https://github.com/WAClient/WALC/stargazers) [![GitHub license](https://img.shields.io/github/license/WAClient/WALC.svg)](https://github.com/WAClient/WALC/blob/master/LICENSE) [![Twitter](https://img.shields.io/twitter/url/https/github.com/WAClient/WALC.svg?style=social)](https://twitter.com/intent/tweet?text=Wow:&url=https%3A%2F%2Fgithub.com%2FWAClient%2FWALC) [![walc](https://snapcraft.io//walc/badge.svg)](https://snapcraft.io/walc)

</p>

A WhatsApp Desktop client for linux systems. This is an unofficial client. Use https://web.whatsapp.com for official web client as official desktop client for linux does not exist.

<img src="https://ga-beacon.appspot.com/UA-144002431-2/walc/readme.md?useReferer&pixel" width="0" height="0" />

<hr/>

# WARNING! This repository is not under *ACTIVE* Development
> You may not get support for your issues but if you are able to fix any issue, feel free to send a PR and I will merge it after review.
<hr/>
## Features
- Tray icon & background running 🏃
Close app to tray, unread message badge (with number!), different tray icon when offline
- Full width ⬅️➡️
Make WhatsApp occupy all available space on large screen (enable it first in settings)
- Chat shortcut ⚡
Use <kbd>Ctrl</kbd>+<kbd>1</kbd> to <kbd>Ctrl</kbd>+<kbd>9</kbd> to switch between your chat quickly
- Native notification 💬
Proper formatting of message (bold, italic, link), mark as read button, and for KDE >=5.18, inline/quick reply
- Notification grouping 🗯
Group multiple rapid notification into one. Notifications now wouldn't cover half your screen when someone's angry 💢
- Offline notification 📶❌
Notifies you when disconnected to network or phone (if you haven't used MD)
- Mark all chat as read ☑☑
Have too many unread chats with too little time? You can _"read"_ them all at once!
- App Lock 🔒
Secure your chat from prying eyes 👀! _Warning:_ it's not very safe, but it should deter most people away

and many more...

## Releases
[![Get it from the Snap Store](https://snapcraft.io/static/images/badges/en/snap-store-black.svg)](https://snapcraft.io/walc)
[![Get it from linux-APPS](https://i.imgur.com/YGU3qMJ.png)](https://www.linux-apps.com/p/1383431/)

To download an AppImage, please goto [Latest Release](https://github.com/cstayyab/WALC/releases/latest) Page

## From SnapStore
```
sudo snap install walc
```
To download an AppImage, please goto [Latest Release](https://github.com/WAClient/WALC/releases/latest) Page

## Using WALC - Prebuilt AppImage
* Download the latest AppImage in ~/.local/bin which is a recommended location for AppImages
Expand All @@ -41,7 +48,7 @@ If you want to get the version which is not yet released, follow the following s
# You must have git, npm and node installed

# clone the repo
git clone https://github.com/cstayyab/WALC.git
git clone https://github.com/WAClient/WALC.git

#Move to WALC directory
cd WALC
Expand All @@ -57,22 +64,18 @@ npm run watch

# start the app
npm start

```
## Feature Requests
To suggest any new feature please start a new discussion in the [Feature Requests](https://github.com/cstayyab/WALC/discussions?discussions_q=category%3A%22Feature+Requests%22) section of [WALC Discussions](https://github.com/cstayyab/WALC/discussions)

You can see the list of old Feature Requests from FeatHub account [here](http://feathub.com/cstayyab/WALC) and it will be closed as soon as we make sure that all the requests have been migrated to WALC Discussions.

<!-- [![Feature Requests](http://feathub.com/cstayyab/WALC?format=svg)]() -->
## Feature Requests
To suggest any new feature please start a new discussion in the [Feature Requests](https://github.com/WAClient/WALC/discussions?discussions_q=category%3A%22Feature+Requests%22) section of [WALC Discussions](https://github.com/WAClient/WALC/discussions)

## Troubleshooting
If you are having any problem related to usage, building or deplying of WALC please reach out to commmunity in [Troubleshooting](https://github.com/cstayyab/WALC/discussions?discussions_q=category%3ATroubleshooting) section of WALC Discussions. Before starting a new discussion please check already created posts as other people might be having same problem as yours or someone might already have addressed and answered the problem you are having.
If you are having any problem related to usage, building or deplying of WALC please reach out to commmunity in [Troubleshooting](https://github.com/WAClient/WALC/discussions?discussions_q=category%3ATroubleshooting) section of WALC Discussions. Before starting a new discussion please check already created posts as other people might be having same problem as yours or someone might already have addressed and answered the problem you are having.

## License
This content of this repository is lisensed under GPL-3.0 or later.

## Contributions
* You may check the issues section to solve an issue and submit a PR.
* Although it isn't necessary to follow priority order for bugs and number of votes for feature request but it would be really good if you follow that.
* You can find a list of "Good First Issues" [here](https://github.com/cstayyab/WALC/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)
* You can find a list of "Good First Issues" [here](https://github.com/WAClient/WALC/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)
5 changes: 2 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "walc",
"version": "0.2.1",
"version": "0.2.2",
"description": "A WhatsApp Desktop client for linux systems. This is an unofficial client. Use https://web.whatsapp.com for official web client as official desktop client for linux does not exist.",
"main": "src/main.js",
"scripts": {
Expand Down Expand Up @@ -33,7 +33,7 @@
"author": "cstayyab <[email protected]> (https://cstayyab.com)",
"license": "GPL-3.0-or-later",
"bugs": {
"url": "https://github.com/cstayyab/WALC/issues"
"url": "https://github.com/WAClient/WALC/issues"
},
"build": {
"appId": "com.cstayyab.linux.unofficial.whatsapp",
Expand Down Expand Up @@ -77,7 +77,6 @@
"vuetifyjs-mix-extension": "0.0.20",
"webpack": "^5.72.0"
},
"homepage": "https://cstayyab.com/projects/walc",
"dependencies": {
"axios": "^0.21.4",
"bcrypt": "^5.0.1",
Expand Down

0 comments on commit 3a60626

Please sign in to comment.