Skip to content

Commit 21ad999

Browse files
committed
Readme updated
1 parent e22ccaa commit 21ad999

18 files changed

+104
-63
lines changed

Readme.md

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -52,32 +52,30 @@ This will start the server, and you will be able to access the application by vi
5252

5353
## Usage
5454

55-
After installing and setting up the project, run the server using the command python3 wsgi.py.
55+
After installing and setting up the project, run the server using the command `python3 wsgi.py`.
5656

57-
Open your web browser and navigate to the URL where the server is running (usually http://localhost:5000).
57+
Open your web browser and navigate to the URL where the server is running (usually `http://localhost:5000`).
5858

5959
On the home page, you will see a search form where you can specify your search criteria.
60+
![Step 1](static/images/1.png)
6061

61-
Choose a topic from the dropdown menu to search for repositories related to that topic.
62+
Write a topic on the search bar and choose the programming language and rating from the drop-down menu as shown in the above picture to search for repositories related to that criteria.
6263

63-
Optionally, select a rating option to filter the repositories by their star rating.
64-
65-
You can also choose a programming language from the dropdown menu to further refine your search.
66-
67-
Click on the "Search" button to initiate the search.
64+
Click on the "Search" button to initiate the search. It will show you the waiting message as shown below:
65+
![Step 1](static/images/2.png)
6866

6967
The search results will be displayed on the next page, showing the repositories that match your criteria.
7068

71-
Each repository will be listed with its name, description, star rating, and other relevant information.
69+
Each repository will be listed with its name, URL, star rating, fork count, and other relevant information.
70+
![Step 1](static/images/3.png)
7271

7372
You can click on a repository to view more details and explore its contents.
7473

75-
Use the navigation links at the top or bottom of the page to navigate through the search results pages.
7674

7775
To perform a new search, simply go back to the home page and enter new search criteria.
7876

7977
Enjoy exploring and discovering interesting GitHub repositories based on your search preferences!
80-
![Step 1](path/to/step1.png)
78+
8179

8280
## Contributing
8381

__pycache__/settings.cpython-311.pyc

-26 Bytes
Binary file not shown.

settings.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,4 +37,4 @@ class Config:
3737
# Enable debug mode.
3838
DEBUG = True
3939
# put your token here
40-
TOKEN = "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"
40+
TOKEN = "Put your token"
7.28 KB
Loading
30.5 KB
Loading
6.62 KB
Loading

static/favicon_io/favicon-16x16.png

375 Bytes
Loading

static/favicon_io/favicon-32x32.png

773 Bytes
Loading

static/favicon_io/favicon.ico

15 KB
Binary file not shown.

static/favicon_io/site.webmanifest

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{"name":"","short_name":"","icons":[{"src":"/android-chrome-192x192.png","sizes":"192x192","type":"image/png"},{"src":"/android-chrome-512x512.png","sizes":"512x512","type":"image/png"}],"theme_color":"#ffffff","background_color":"#ffffff","display":"standalone"}

0 commit comments

Comments
 (0)