Skip to content

Commit

Permalink
update doc
Browse files Browse the repository at this point in the history
  • Loading branch information
d99kris committed Nov 26, 2023
1 parent 1fdd769 commit c48a9be
Showing 1 changed file with 23 additions and 21 deletions.
44 changes: 23 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
nchat - ncurses chat
====================
nchat
=====

| **Linux** | **Mac** |
|-----------|---------|
Expand All @@ -21,26 +21,7 @@ Features
- Searchable list dialogs for selecting files, emojis, contacts
- Show user status (online, away, typing)
- Toggle to view textized emojis vs. graphical
- Toggle to view UI elements (top bar, status bar, help bar, contact list)
- View / save media files (documents, photos, videos)
- Customizable color schemes and key bindings

Limitations
-----------
There are no plans to support the following features:
- Facebook Messenger
- Signal
- Telegram secret chats
- Voice / video calls

Roadmap
-------
There is currently no concrete roadmap for further feature development of
nchat. It is not intended to be a full-featured client on par with official
Telegram / WhatsApp clients, but rather a light-weight client providing
essential functionality suitable for the terminal. However, feel free to
submit feature requests if there's something missing, and if it's useful
and low effort it can probably be added.


Usage
Expand Down Expand Up @@ -864,6 +845,27 @@ Uncrustify is used to maintain consistent source code formatting, example:
./make.sh src


Project Scope
=============

Limitations
-----------
There are no plans to support the following features:
- Facebook Messenger
- Signal
- Telegram secret chats
- Voice / video calls

Roadmap
-------
There is currently no concrete roadmap for further feature development of
nchat. It is not intended to be a full-featured client on par with official
Telegram / WhatsApp clients, but rather a light-weight client providing
essential functionality suitable for the terminal. However, feel free to
submit feature requests if there's something missing, and if it's useful
and low effort it can probably be added.


License
=======
nchat is distributed under the MIT license. See LICENSE file.
Expand Down

0 comments on commit c48a9be

Please sign in to comment.