miha42-github / company_dns

An open source micro-service focused that provides company data from EDGAR plus Wikipedia, and SIC lookup.
https://miha42-github.github.io/company_dns/
Apache License 2.0
9 stars 2 forks source link

Rewrite the README.md file #9

Closed miha42-github closed 1 year ago

miha42-github commented 1 year ago

The README.md file doesn't reflect the current state of the service and needs to be improved. The major focus will be on the installation and startup process. Additionally, the overall motivation section, status, etc. needs to be updated to reflect the change in strategy. We will reuse as much as possible and add appropriate screenshots to enrich the documentation. We can and should also consider bringing links to the documentation so users can see an example in action.

miha42-github commented 1 year ago

Base file rewritten, some minor changes remain to pursue:

After these are completed then we will declare this issue closed.