adding godoc

This commit is contained in:
Prashant Gupta 2019-05-01 18:28:55 -07:00
parent 118bce49e0
commit 8e8be9bbe9
1 changed files with 24 additions and 0 deletions

24
pkg/mousemover/doc.go Normal file
View File

@ -0,0 +1,24 @@
/*
Ever felt the need to keep your machine awake without having to resort to the age-old
methods of installing an app that you don't trust or playing a video? Well, not anymore!
Introducing the simplest app on the market that has the sole purpose of moving your mouse
pointer at regular intervals so that your machine never sleeps! And best of all, it works
ONLY when you are not working, so be rest assured that the mouse won't start moving on its
own without the machine actually being idle.
Installation
The libary can be installed using:
go get -u github.com/automatic-mouse-mover/pkg/mousemover
Usage
Clone this repo and run Make, it should create the amm.app and open the folder where
it was built for you. You just have to drag and drop it to the Applications folder on your mac.
Refer to the README for more details.
*/
package mousemover