Skip to content

Commit

Permalink
made changes to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
PatrickNgare committed Jan 14, 2018
1 parent d1eaac2 commit 4dd1325
Showing 1 changed file with 5 additions and 34 deletions.
39 changes: 5 additions & 34 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# Github Look Up

###13th january 2018
### 13th january 2018
### By patrick Ngare

#Description

Github lookup is a web application where you insert github username and the app searches for you and it displays the user information in github account

##Setup/Installation
## Setup/Installation
Install Angular CLI

Install Typescript(npm install -g typescript )
Expand Down Expand Up @@ -39,42 +39,13 @@ Node.js

HTML

##Bugs
## Bugs
There are no known Bugs

##Github API
This app uses the GitHub API to retrieve the data. This API allows 5,000 requests per hour with an API key, but only 60 requests per hour without one. Everyone is therefore required to use their own unique key.
This app uses the GitHub API to retrieve the data. This API allows 5,000 requests per hour with an API key, but only 60 requests per hour without one. Everyone is therefore required to use their own unique key.

##License
## License
This project is licenced under the MIT License.

Copyright (c) 2018 Patrick Ngare






## Development server

Run `ng serve` for a dev server. Navigate to `http://localhost:4200/`. The app will automatically reload if you change any of the source files.

## Code scaffolding

Run `ng generate component component-name` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module`.

## Build

Run `ng build` to build the project. The build artifacts will be stored in the `dist/` directory. Use the `-prod` flag for a production build.

## Running unit tests

Run `ng test` to execute the unit tests via [Karma](https://karma-runner.github.io).

## Running end-to-end tests

Run `ng e2e` to execute the end-to-end tests via [Protractor](http://www.protractortest.org/).

## Further help

To get more help on the Angular CLI use `ng help` or go check out the [Angular CLI README](https://github.com/angular/angular-cli/blob/master/README.md).

0 comments on commit 4dd1325

Please sign in to comment.