Skip to content

Commit

Permalink
add license and readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Teshvier Mathura committed Jun 2, 2020
1 parent 2b5473b commit 93e2091
Show file tree
Hide file tree
Showing 2 changed files with 39 additions and 0 deletions.
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2020 Spacearr

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
| Master | Dev | Current |
|-------|-------|-------|
| [![Build status](https://ci.appveyor.com/api/projects/status/v6fykek56q66lwqm/branch/master?svg=true)](https://ci.appveyor.com/project/tmathura/spacearr/branch/master) | [![Build status](https://ci.appveyor.com/api/projects/status/v6fykek56q66lwqm/branch/dev?svg=true)](https://ci.appveyor.com/project/tmathura/spacearr/branch/dev) | [![Build status](https://ci.appveyor.com/api/projects/status/v6fykek56q66lwqm?svg=true)](https://ci.appveyor.com/project/tmathura/spacearr) |

# Spacearr
Spacearr allows you to monitor your hard disk space on you computer via an Android phone or via a Windows UWP app. This is done without opening any ports on a computer but by using a message service from [Pusher](https://pusher.com/). The messaging service that [Pusher](https://pusher.com/) offers us is a "Pub/Sub" service, which is an asynchronous messaging service which is used by the computer and Android/UWP app to communicate to one another.

# Spacearr Android App
This is the app that is used on the Android phone to check the different drives on the computer. You can see the total space and as well as the free space. You will get notifications every 15 minutes if there is low space.

# Spacearr UWP App
This is the app that is used on the Windows computer to check the different drives on the computer. You can see the total space and as well as the free space.

# Spacearr Windows Service
This is the Windows service that you will install onto the computer so that the computer and Android/UWP app can communicate.

# Spacearr Windows Worker Service
This is the Windows worker service that you will install onto the computer so that the computer and Android/UWP app can communicate. It is basically the same as a Windows service, but more modern and uses the [.Net Core](https://en.wikipedia.org/wiki/.NET_Core) Framework. See this Stackoverflow [answer](https://stackoverflow.com/questions/59636097/c-sharp-worker-service-vs-windows-service#:~:text=Both%20are%20real%20services.,and%20stops%20with%20the%20application.) for more information.

0 comments on commit 93e2091

Please sign in to comment.