Fix markdown violations on Readme

systemcatch / eiapy

A simple wrapper for the U.S. Energy Information Administration API

https://pypi.org/project/eiapy/

MIT License

23 stars 8 forks source link

Fix markdown violations on Readme #22

Open areed1192 opened 3 years ago

areed1192 commented 3 years ago

Went through and cleaned up the README.md file. I was planning on doing some refactoring of the code if you're open to it.

systemcatch commented 3 years ago

Hey @areed1192, congratulations on making the first PR to eiapy that isn't from me! :laughing:

What did you have in mind for refactoring?

areed1192 commented 3 years ago

Oh trust me I've been there 😆! For the most part when it comes to refactoring I was thinking of splitting up the main client file into a folder called epa and then having a file dedicated for each service. If you want an idea of how I'm thinking of the structure you can look at one of my repos for reference.

Let me know what you think.