diff --git a/README.md b/README.md index 413a913..9b3b2ac 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,17 @@ -# mterm -An electron terminal written with React and TypeScript. +

mterm

+
An electron terminal written with React and TypeScript.
+

+ slate@taff +

+
Join us on discord @ discord.gg/mterm
-![image](https://github.com/mterm-io/mterm/assets/7341502/27bcad62-6891-4b49-80b5-e5a17e0562ab) +[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=mterm-io_mterm&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=mterm-io_mterm) +[![release](https://github.com/mterm-io/mterm/actions/workflows/release.yml/badge.svg)](https://github.com/mterm-io/mterm/actions/workflows/release.yml) -## Community +> This documentation is a work in progress! -Join us on discord [here](https://discord.gg/mterm)! - -## Extend with commands +### Commands Need your own command? MTERM includes `~/mterm/commands.ts` from your home directory - with any exported functions as available commands. @@ -28,7 +31,7 @@ Now run `hello X` from mterm - > In this case, no argument was provided so the `os.userInfo().username` was the fallback. `Hello, DR` is the result! -## Project Setup +### Project Setup ### Install