search

nkowaokwu / webscraper

scrapes the BBC Igbo daily
3 stars 3 forks source link

Update README #2

Closed ijemmao closed 3 months ago

ijemmao commented 3 years ago

Background

Documentation is an absolute must. Even though you might know everything that you've written right now, months in the future it might be harder to remember everything.

Ideal Solution

For this ticket, you should update the README with the following information:

  1. A 'Scripts' section that describes the steps on running script.py and a short description of what script.py accomplishes
  2. A 'Background' section that briefly (in a couple sentences) what the project accomplishes

Note: Complete this ticket once #1 has been merged into main

Main Goal

The main goal for this project is to document how the start up this project and describe the purpose of this project at a very high level. Once this repo is made public, it will be easy for the community read through.

ijemmao commented 3 months ago

Closing since this is no longer needed