Skip to content

Commit

Permalink
💄 Add more instructions and preview make it public ready
Browse files Browse the repository at this point in the history
  • Loading branch information
aashutoshrathi committed Feb 12, 2020
1 parent 623bfec commit 8de0aeb
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 2 deletions.
19 changes: 17 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,13 @@
# Jira Issues Menu Bar App
# Jira ToDo

A simple menu bar app which helps you in keeping track of your Jira tickets 🎟.

It opens the issue on click and also you can update them with the refresh button.

### Preview (masked sensitive content)

![image](demo.png)

## Configuration

Create a `todo-app.json` file in your home directory.
Expand All @@ -24,10 +30,19 @@ and make an object similar to this

Get your API key from [Manage API Keys](https://id.atlassian.com/manage/api-tokens)

## Download
## Download (Currently now working)

Get the latest app from [release section](https://github.com/aashutoshrathi/Jira-Todo-MenubarApp/releases)

## Build and Run locally

- Clone the repo
- Install pipenv using `pip install -U pipenv`
- Create new Virtual Env using `pipenv shell`
- Install dependencies using `pipenv install`
- Build with development hook using `python3 setup.py py2app -A`
- Run the `Jira Todo.app` file in `dist/`

## Developement Setup

- Install pipenv using `pip install -U pipenv`
Expand Down
Binary file added demo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 8de0aeb

Please sign in to comment.