diff --git a/README.md b/README.md index 4ab3c605..40d60fa9 100644 --- a/README.md +++ b/README.md @@ -1 +1,20 @@ # GoodFirstIssue + +About this Project +This project is a web application that helps new contributors find great open-source opportunities. + +The goal is to make it easy for new developers to make their first code contribution to open source by providing a simple, searchable interface. + +How It Works +The application uses the GitHub GraphQL API to search for issues across different programming languages. It then displays these issues, grouped by repository, along with key information like the number of stars, last update date, and a direct link to the repository. + +Contributing +This project is designed to be a good starting point for new contributors. If you are looking to make your first contribution, consider the following: + +-Fixing a bug + +-Improving the documentation + +-Adding new features + +We welcome all contributions and are happy to help you get started! diff --git a/index.html b/index.html index 1f6f9d4a..362a6d89 100644 --- a/index.html +++ b/index.html @@ -1,6 +1,7 @@ + Good First Issue @@ -15,7 +16,7 @@