Skip to content

Commit

Permalink
update gifs and images
Browse files Browse the repository at this point in the history
  • Loading branch information
spaced4ndy committed Sep 11, 2021
1 parent 2339f61 commit 5ab22b0
Show file tree
Hide file tree
Showing 8 changed files with 14 additions and 46 deletions.
25 changes: 14 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,15 @@
[![GitHub build](https://github.com/simplex-chat/simplex-chat/workflows/build/badge.svg)](https://github.com/simplex-chat/simplex-chat/actions?query=workflow%3Abuild)
[![GitHub release](https://img.shields.io/github/v/release/simplex-chat/simplex-chat)](https://github.com/simplex-chat/simplex-chat/releases)

> **New in v0.4 is support for file transfers and groups functionality! (see details below)**
The motivation for SimpleX chat is [presented here](./simplex.md).

SimpleX chat prototype is a thin terminal UI on top of [SimpleXMQ](https://github.com/simplex-chat/simplexmq) message broker that uses [SMP protocols](https://github.com/simplex-chat/simplexmq/blob/master/protocol), implementing direct and group messaging and file transfer.
SimpleX chat prototype is a thin terminal UI on top of [SimpleXMQ](https://github.com/simplex-chat/simplexmq) message broker that uses [SMP protocols](https://github.com/simplex-chat/simplexmq/blob/master/protocol).

See [simplex.chat](https://simplex.chat) website for chat demo and the explanations of the system and how SMP protocol works.

![simplex-chat](./images/simplex-chat.gif)

(Video is for the previous version, a new video will be added soon)
![simplex-chat](./images/connection.gif)

## Table of contents

Expand All @@ -30,7 +30,8 @@ See [simplex.chat](https://simplex.chat) website for chat demo and the explanati
- [Usage](#usage)
- [Running the chat client](#running-the-chat-client)
- [How to use SimpleX chat](#how-to-use-simplex-chat)
- [File transfer and groups](#file-transfer-and-groups)
- [File transfer](#file-transfer)
- [Groups](#groups)
- [Access chat history](#access-chat-history)
- [Roadmap](#roadmap)
- [License](#license)
Expand Down Expand Up @@ -156,10 +157,8 @@ Once you have started the chat, you will be prompted to specify your "display na

This diagram shows how to connect and message a contact:

<!-- TODO fix commands in image -->

<div align="center">
<img align="center" src="images/how-to-use-simplex.svg">
<img align="center" src="images/how-to-use-simplex.png">
</div>

Once you've set up your local profile, enter `/c` (for `/connect`) to create a new connection and generate an invitation. Send this invitation to your contact via any other channel.
Expand All @@ -172,14 +171,18 @@ They would then use `@<name> <message>` commands to send messages. You may also

Use `/help` in chat to see the list of available commands.

### File transfer and groups

New in v0.4 is support for file transfers and groups functionality.
### File transfer

You can initiate file transfer to your contact by running `/f @<contact> <file_path>` (`/f` for `/file`), after which he would be able to asynchronously accept it. For checking the status of a file transfer use `/fs <file_id>`. See `/help files` for other commands.

![simplex-chat](./images/file-transfer.gif)

### Groups

To create a group enter `/g <group>` command (`/g` for `/group`) - afterwards you can add your contacts to it and you can exchange messages using `#<group> <message>` commands. See more group related commands with `/help groups`. You can also initialize a file transfer to a group by running `/f #<group> <file_path>`.

![simplex-chat](./images/groups.gif)

### Access chat history

🚧 **Section currently out of date - will be updated soon** 🏗
Expand Down
Binary file added images/connection.gif
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/file-transfer.gif
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/groups.gif
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/how-to-use-simplex.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
32 changes: 0 additions & 32 deletions images/how-to-use-simplex.svg

This file was deleted.

Binary file removed images/simplex-chat.gif
Binary file not shown.
3 changes: 0 additions & 3 deletions images/strapline.svg

This file was deleted.

0 comments on commit 5ab22b0

Please sign in to comment.