Skip to content

Commit

Permalink
Adds missing info to readme.md and fix the links
Browse files Browse the repository at this point in the history
  • Loading branch information
lucasff committed Apr 18, 2022
1 parent c02ab67 commit e756820
Showing 1 changed file with 11 additions and 57 deletions.
68 changes: 11 additions & 57 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,80 +1,34 @@
# electron-boilerplate

> Boilerplate to kickstart creating an app with [Electron](https://github.com/electron/electron)
# WhatsApp Caller

See [awesome-electron](https://github.com/sindresorhus/awesome-electron) for more useful Electron resources.

See [Caprine](https://github.com/sindresorhus/caprine) for a production app based on this boilerplate.

## Features

- [`electron-builder`](https://www.electron.build) fully set up to create cross-platform builds
- [Builds the app on CI](https://www.electron.build/multi-platform-build.html)
- [Silent auto-updates](https://www.electron.build/auto-update.html)
- App menu that adheres to the system user interface guidelines
- [Config handling](https://github.com/sindresorhus/electron-store)
- [Context menu](https://github.com/sindresorhus/electron-context-menu)
- [User-friendly handling of unhandled errors](https://github.com/sindresorhus/electron-unhandled)
- Easily publish new versions to GitHub Releases
- And much more!

## Getting started

**Click the "Use this template" button.**

Alternatively, create a new directory and then run:

```
$ curl -fsSL https://github.com/sindresorhus/electron-boilerplate/archive/main.tar.gz | tar -xz --strip-components 1
```

There's also a [Yeoman generator](https://github.com/sindresorhus/generator-electron).

---

**Remove everything from here and above**

---

# App Name

> The best app ever
> An app to open any phone link (tel: and callto:) in any website.
## Install

*macOS 10.10+, Linux, and Windows 7+ are supported (64-bit only).*

**macOS**

[**Download**](https://github.com/user/repo/releases/latest) the `.dmg` file.
[**Download**](https://github.com/lucasff/electron-whatsapp-caller/releases/latest) the `.dmg` file.

**Linux**

[**Download**](https://github.com/user/repo/releases/latest) the `.AppImage` or `.deb` file.
[**Download**](https://github.com/user/electron-whatsapp-caller/releases/latest) the `.AppImage` or `.deb` file.

*The AppImage needs to be [made executable](http://discourse.appimage.org/t/how-to-make-an-appimage-executable/80) after download.*

**Windows**

[**Download**](https://github.com/user/repo/releases/latest) the `.exe` file.

---
[**Download**](https://github.com/electron-whatsapp-caller/releases/latest) the `.exe` file.

## Dev

Built with [Electron](https://electronjs.org).
## Getting started

### Run
**Open the app once for registering the protocols.**

```
$ npm install
$ npm start
```
The app doesn't stay running in the background. It opens only to start WhatsApp.

### Publish
---

```
$ npm run release
```
## Credits

After Travis finishes building your app, open the release draft it created and click "Publish".
Built with [Electron](https://electronjs.org).

0 comments on commit e756820

Please sign in to comment.