Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
nofosoft committed Aug 1, 2023
1 parent 8850de3 commit c85d7cb
Showing 1 changed file with 19 additions and 59 deletions.
78 changes: 19 additions & 59 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,9 @@
# GitHub Repositories Explorer

## Descriptions

### GitHub Repositories Explorer

React application which integrates with github.com API and allows user to search for up
to 5 users with a username similar to the value entered in text input and then on click display repositories
(no limit on displayed repositories amount) for selected GitHub user

API docs URL: https://developer.github.com/v3/

## ------------------------------------------------

# GitHub Repositories Explorer

GitHub Repositories Explorer or GRE is a react application which integrates with github.com API and allows user to search for up to 5 users with a username similar to the value entered in text input.

Live demo : https://jaml.my.id

## Description

This application which integrates with github.com API and allows user to search for up
Expand All @@ -26,6 +14,18 @@ API docs URL: https://developer.github.com/v3/

## Getting Started

- Download the from the repositories or this link [https://github.com/arhscrypt/gre.git] for the project.
- Install the dependencies
- build and run the project

### Dependencies

- Fortawesome-free for the icons
- Octokit to using GitHub API services
- Using Tailwind css for styling of UI.

### Installing

- Download the from the repositories or this link [https://github.com/arhscrypt/gre.git] for the project.
- Install the dependencies

Expand All @@ -45,58 +45,18 @@ npm run build
npm start
```

### Dependencies

- Describe any prerequisites, libraries, OS version, etc., needed before installing program.
- ex. Windows 10

### Installing

- How/where to download your program
- Any modifications needed to be made to files/folders

### Executing program

- How to run the program
- Step-by-step bullets

```
code blocks for commands
```

## Help

Any advise for common problems or issues.

```
command to run if program contains helper info
```

## Authors

Contributors names and contact info
Contributors and contact info

ex. Dominique Pizzie
ex. [@DomPizzie](https://twitter.com/dompizzie)
Jamaludin
[IG - @ab_aariz](https://www.instagram.com/ab_aariz/)

## Version History

- 0.2
- Various bug fixes and optimizations
- See [commit change]() or See [release history]()
- 0.1
- 1.0.0
- Initial Release

## License

This project is licensed under the [NAME HERE] License - see the LICENSE.md file for details

## Acknowledgments

Inspiration, code snippets, etc.

- [awesome-readme](https://github.com/matiassingers/awesome-readme)
- [PurpleBooth](https://gist.github.com/PurpleBooth/109311bb0361f32d87a2)
- [dbader](https://github.com/dbader/readme-template)
- [zenorocha](https://gist.github.com/zenorocha/4526327)
- [fvcproductions](https://gist.github.com/fvcproductions/1bfc2d4aecb01a834b46)
This project is licensed under the [MIT License] License - see the LICENSE.md file for details

0 comments on commit c85d7cb

Please sign in to comment.