Skip to content

Commit

Permalink
README.md: Change contents to reflect update
Browse files Browse the repository at this point in the history
This commit updates readme to reflect changes in unification

Related to manu-chroma#104
  • Loading branch information
suggoitanoshi committed Oct 30, 2018
1 parent e6f2df2 commit fc6a1aa
Showing 1 changed file with 7 additions and 8 deletions.
15 changes: 7 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

[![Join the chat at https://gitter.im/username-availability-checker/Lobby](https://badges.gitter.im/username-availability-checker/Lobby.svg)](https://gitter.im/username-availability-checker/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

Check if a username can or cannot be taken on a bunch of popular social websites (such as Twitter, Instagram, Soundcloud, Github etc.)
Check if a username can or cannot be taken on a bunch of popular social websites (such as Twitter, Instagram, Soundcloud, Github etc.)

Try it out at: https://username-check.herokuapp.com/

Expand Down Expand Up @@ -37,11 +37,10 @@ copy .env.copy .env
You can choose to edit the default config before running the project


### Running the web app
### Running the web app

```
python username_api.py &
python frontend.py
python username_checker.py
```

To use, go to address generated by flask app in a browser.
Expand All @@ -65,16 +64,16 @@ python cli.py

## Backend API endpoint

This endpoint is responsible for returning the username status to the frontend
This endpoint is responsible for returning the username status to the frontend

- https://username-availability.herokuapp.com/check/<website name>/``<username>/``
- eg: https://username-availability.herokuapp.com/check/facebook/yolo
- https://username-availability.herokuapp.com/api/check/`<website name>`/`<username>/``
- eg: https://username-availability.herokuapp.com/api/check/facebook/yolo

## Contributors

Since the inception of the project, it has on and off been in developement. It has seen minor contributions during hacktoberfest and major contributions from students during Google Codein 2017.

For the time being, the project is being maintained actively.
For the time being, the project is being maintained actively.

## License
```
Expand Down

0 comments on commit fc6a1aa

Please sign in to comment.