Merge branch 'master' of https://github.com/GabrielTK/DropMeter

KitsuneDev · Feb 7, 2021 · 1dd239a · 1dd239a
2 parents 6435061 + c9c0f72
commit 1dd239a
Showing 1 changed file with 31 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,31 @@
+<img src="https://github.com/GabrielTK/DropMeter/raw/master/DropMeter/Resources/logo.png" width="100" height="100">
+
+# DropMeter
+Modern, easy to create Widgets for your Desktop.
+
+## What is this?
+
+DropMeter is a software that allows for desktop widgets to be built with the well-known and loved Web Stack, making use of the latest Web Technologies.
+
+Think Rainmeter, but with richer and easier to make widgets.
+
+## Is this a replacement for Rainmeter?
+
+I wouldn't say a _replacement_, per see. Rainmeter was initially releasen back in 2001, and it excels at rendering widgets with low resource usage. However, times have changed, and with the new design trends, many crave for more interactive, responsive and intelligent widgets. That's where DropMeter comes in.
+I personally like to combine both, running clocks and audio visualizers on RainMeter and my fancy things on DropMeter.
+
+## Can I do (insert fancy rainmeter widget feature here)?
+
+Probably yes! But if you cannot, don't worry, we are paving the way to enable you to do it.
+Like RainMeter, DropMeter is built on plugins that can send and receive data from widgets. However, there is an essential difference: All DropMeter Plugins are built with C#, and thus Garbage Collected, therefore making it extremely difficult to have memory leaks and such.
+If you are a Developer, don't worry, we have built things so that using our fancy plugin system is as easy as requiring libraries available in NuGet (for plugins) / npm (for Widgets; of course with TypeScript definitions, we are decent people after all) and extending an interface / registering your callbacks.
+We even have a built-in WebNowPlaying Plugin, so you don't need to make that extra effort to display your songs information.
+
+## I hear the Web Stack is heavy... Will my memory go brrrr?
+
+I wouldn't worry: Our runtime is pretty optimized, and seems to be able to handle things quite smoothly.
+Testing on my machine with my word-by-word lyrics widget (quite heavy, uses React, Framer Motion animations and an interval-based tick system) tops usage at 1% CPU and 79MB on RAM.
+
+## Cool... Where Can I get it?
+
+Happy you are excited! I am currently finishing stuff for our release, but you soon will be able to get it from a link I will post here.