Skip to content

Commit

Permalink
docs: add basic readme and license
Browse files Browse the repository at this point in the history
fix #19
  • Loading branch information
Xiphe committed Apr 17, 2020
1 parent 8f51b21 commit 1ca3c7b
Show file tree
Hide file tree
Showing 2 changed files with 87 additions and 0 deletions.
20 changes: 20 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
The MIT License

Copyright (C) 2020 Hannes Diercks

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.
67 changes: 67 additions & 0 deletions readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
<div align="center">
<img
width="150"
src="https://user-images.githubusercontent.com/911218/79590208-f6313c80-80d6-11ea-9ecc-67c94f32f4f7.png"
alt="BudgetBudget App Icon"
/>
</div>
<h1 align="center">BudgetBudget</h1>

Envelope styled budgeting using your [MoneyMoney](https://moneymoney-app.com/)
transactions.

## How to use

This app is currently still in development and not officially released.
If you still want to use it you need to build it yourself. See

## Contributing

You're really welcome to submit Pull Requests and Issues.

Please keep in mind that i'm building this app in my free time and don't plan to
monetize it.
That means all help is really welcome but it might take some time for me to
respond to issues or review PRs.

### Run the app in development mode

All of the following assume that you're working on a recent version of MacOS and
have [NodeJS](https://nodejs.org/) installed.

Run the following in your terminal:

```sh
# check out the source-code
git clone git@github.com:Xiphe/budgetbudget.git
cd budgetbudget

# install dependencies
npm install

# start the app in development mode
npm start
```

## License

> The MIT License
>
> Copyright (C) 2020 Hannes Diercks
>
> 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.

0 comments on commit 1ca3c7b

Please sign in to comment.