Skip to content
Open
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
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,26 @@
Hello! This was an enjoyable project 🙂. Here's some information about it:

A change again

## Installation

- Type `npm install` (or yarn if preferred) to install dependencies.

## To run the app

- Type `npm start` to run the application, and open [http://localhost:3000](http://localhost:3000) to view it in the browser.
- Enter a GitHub API key (e.g. a personal access token) into the input field to see your repositories
- Click on a listed repository to view its issues
- Click the up or down arrows on the left of each issue to reorder the issues

## To run tests

- Type `npm test` to run the Jest test suite.

<hr>

### TODO (in order of importance, descending)

- Achieve more test coverage (particularly of components)
- Replace non-semantic HTML tags with semantic ones
- Include JSDoc-style annotations to components / functions
Expand All @@ -25,4 +30,4 @@ Hello! This was an enjoyable project 🙂. Here's some information about it:

<br>

*(This project was bootstrapped with Create React App)*
_(This project was bootstrapped with Create React App)_