Updated README to _hopefully_ improve it

pytransitions / transitions

A lightweight, object-oriented finite state machine implementation in Python with many extensions

MIT License

5.48k stars 525 forks source link

Updated README to _hopefully_ improve it #650

Closed juan11iguel closed 1 month ago

juan11iguel commented 2 months ago

Related to #649.

Maybe I was having a hard time accepting the fact that I can't read, anyway decided to try improving the documentation.

I moved some content to different sections and added a couple more to hopefully make it easier to comprehend.

Feel free to reject the PR if it does not (🥲)

Best regards, Juanmi

aleneum commented 1 month ago

Hello @juan11iguel,

sorry for the late response. Thank you for reviewing the Readme. It's always a big help when people who read it the first time provide feedback. Far better than when I try to estimate what newbies might need to know.

Cheers!