Skip to content

Commit d7177e6

Browse files
authored
docs: update readme
1 parent 878ecf7 commit d7177e6

File tree

1 file changed

+14
-13
lines changed

1 file changed

+14
-13
lines changed

README.md

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,35 @@
1-
# Helmer Micro
2-
31
![](banner.png)
42

3+
# Helmer Micro
4+
55
![Stage: Alpha](https://img.shields.io/static/v1?label=Stage&message=Alpha&color=2BB4AB)
66
[![License: AGPL3.0](https://img.shields.io/static/v1?label=Licence&message=AGPL%20v3&color=000)](https://www.gnu.org/licenses/agpl-3.0)
77
[![Twitter: @HelmerApp](https://img.shields.io/badge/Twitter-00acee?logo=twitter&logoColor=white)](https://twitter.com/helmerapp)
88
![Github Stars](https://img.shields.io/github/stars/helmerapp/micro)
99

10-
Helmer Micro is a commercial open source (COSS) cross-platform GIF recorder. It is written in Typescript and Rust, using the awesome desktop app framework [Tauri](https://github.com/tauri-apps/tauri), our high-performance capture engine [scap](https://github.com/helmerapp/scap) and the fabulous encoder, [Gifski](https://github.com/ImageOptim/gifski).
10+
Helmer Micro is a cross-platform GIF recording app — built using the awesome [Tauri](https://github.com/tauri-apps/tauri) framework, our high-performance capture engine [scap](https://github.com/helmerapp/scap) and the incredible GIF encoder, [Gifski](https://github.com/ImageOptim/gifski).
1111

1212
> ⚠️ This project is in Alpha and things break often. Please use at your own risk.
1313
1414
## Motivation
1515

16-
GIFs are clearly the internet's favourite file format, but notoriously hard to create. We wanted to create a small tool that allows easy, effortless creation of GIFs and share it with as many people as possible!
17-
18-
In addition to our small mission, this project also stands for 2 things:
16+
GIFs are clearly the internet's favourite file format, but notoriously hard to create. We wanted to create a small tool to allows easy and effortless creation of GIFs, and share it with everyone!
1917

20-
1. an example of how to use our library [scap](https://github.com/helmerapp/scap) and
21-
2. show that open-source software can (and should!) be beautifully designed!
18+
Alongside our small mission, this project also stands for two more things:
19+
1. a demo project for our library [scap](https://github.com/helmerapp/scap) and
20+
2. show that open-source apps can (and should) be beautifully designed!
2221

2322
## COSS?
2423

25-
Yup, Commercial Open-source Software! Many of the libraries and tools we make are kept up-to-date and made available to everyone though Github and other platforms. We believe in operating with full transparency, building alongside our community and support our peer OSS projects along the way. This way, everyone benefits instead of running circles within walled gardens.
24+
Yup, Commercial Open-source Software!
25+
26+
Many of the libraries and tools we author are kept up-to-date and made available to everyone though our Github and other platforms. We believe in operating with full transparency, building alongside our community and supporting peer OSS projects along the way. This way, everyone benefits from each other's work instead of running circles within individual walled gardens.
2627

27-
If you benefit from our work, we request that you buy a license via [our website](https://www.helmer.app/micro). This commercialization allows us to become sustainable and also creates a symbiosis between OSS and its proprietary license counterpart — a credible new way of funding our work and experiments!
28+
If you benefit from our work, we request that you buy a license via [our website](https://www.helmer.app/micro). This commercialization allows us to become a sustainable business and eventually work towards a credible new way of funding our work and experiments!
2829

29-
Of course, you are more than welcome to build your own binaries using our source-code! Please also reach out via our Discord if you need help setting this up.
30+
Of course, you are more than welcome to build your own binaries using our source-code! Please reach out in the `#micro` channel on our Discord if you need help setting this up.
3031

31-
Don't forget to share your GIFs online with a `#MadeWithMicro` hashtag, we would love to see and share what you make!
32+
Lastly, don't forget to share your GIFs online with a `#MadeWithMicro` hashtag! We'd love to see and share what you make 🫶
3233

3334
## Development
3435

@@ -40,7 +41,7 @@ Don't forget to share your GIFs online with a `#MadeWithMicro` hashtag, we would
4041

4142
### Guide
4243

43-
This is a [Tauri](https://tauri.app) app. It uses [Astro](https://astro.build) for UI and Rust for the backend.
44+
This is a [Tauri](https://tauri.app) app written in Typescript and Rust. It uses [Astro](https://astro.build) for UI and Rust for the backend.
4445

4546
1. To spin up the dev environment, run `yarn tauri dev`
4647
2. To build the app for your current OS/architecture, run `yarn tauri build`

0 commit comments

Comments
 (0)