Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

#7 Update readme #8

Merged
merged 1 commit into from
Jun 9, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 16 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,23 @@ Create new tasks in your GitHub repositories. See current Freeware version of Gi
![pep8](https://github.com/dseichter/GithubIssueClient/actions/workflows/pep8.yml/badge.svg)
![trivy](https://github.com/dseichter/GithubIssueClient/actions/workflows/trivy.yml/badge.svg)

## First draft of new window
## About

![Main Window](images/mainwindow.png)
With my **GitHub Issue Client** you can easily and quickly create new tasks within your GitHub repositories. You can access all your available repositories and always get the latest data to create new tasks. All you need is to provide your username and the corresponding Personal Access Token. You create this in your Github profile. Are you using **GitHub Enterprise**? No problem, just provide your instance URL.

![GitHub Issue Client](/images/githubissueclient.png "GitHub Issue Client")

## Installation and configuration of GitHub Issue Client

Download the [latest release](https://github.com/dseichter/GithubIssueClient/releases) and save the file in a directory of your choice. In this directory the program creates its configuration file automatically. Depending on how many different GitHub accounts you use, create another subdirectory each with a copy of the executable.

When you start the application for the first time, it checks whether you have already specified a user name and a personal access token (PAT). If this is not the case, enter your own data on the configuration tab. We reload your repositories every time you start the program. This way the program will always show you the latest data. In addition you have the possibility to reload the list of your repositories at any time also over the button again.

![GitHub Issue Client - Configuration](/images/githubissueclient_configuration.png "GitHub Issue Client - Configuration")

# Contributing

If you want to contribute by fixing an issue, add a new function or just optimize something, a simple instruction how to start development.

## Start development

Expand Down
Binary file added images/githubissueclient.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/githubissueclient_configuration.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed images/mainwindow.png
Binary file not shown.