Enhanchment: Transfer documentation from the module to README.md

Question

Enhanchment: Transfer documentation from the module to README.md

Closed this issue a month ago · 6 comments

The README says refer to the module for documentation, can the documentation simply be copied over to the README? I would be willing to do that and do some minor touchups.

Answer 1 · 2023-11-29T16:03:59.000Z

Should I go ahead and make a pr for this?

Answer 2 · 2023-12-04T21:05:55.000Z

Is there a chance a pr for this would get accepted?

Answer 3 · 2023-12-05T04:20:31.000Z

Sorry for the delay. It's towards the end of the semester, so things have gotten pretty busy for me. A PR to add documentation would be accepted, but as said may take a little while to be reviewed/merged until my schedule clears up.

Answer 4 · 2023-12-24T17:36:57.000Z

I'll try to get to doing this in the next week.

Answer 5 · 2024-01-26T15:10:21.000Z

Ok, that was a complete lie, I might get to it this week idk.

Answer 6 · 2024-01-29T14:15:17.000Z

This will be fixed #59