refactor README and split into DOCUMENTATION.md - Githubissues

amazon-connect / amazon-connect-chat-interface

Amazon Connect Chat Interface - a browser-based customer chat widget for your website integrating with Amazon Connect ChatJS

https://docs.aws.amazon.com/connect/latest/adminguide/what-is-amazon-connect.html

MIT No Attribution

33 stars 35 forks source link

refactor README and split into DOCUMENTATION.md #124

Closed spencerlepine closed 11 months ago

spencerlepine commented 1 year ago

Precursor to https://github.com/amazon-connect/amazon-connect-chat-interface/pull/150

Description of changes: Organized README and created new DOCUMENTATION.md for cleaner walkthrough

❌ BEFORE: https://github.com/amazon-connect/amazon-connect-chat-interface/blob/af3ffd5b3a58783eb8aefd969df68bbc98df8252/README.md

✅ AFTER: https://github.com/amazon-connect/amazon-connect-chat-interface/tree/spenlep/improve-readme-documentation

Checklist

[x] Refactor README file to be read-able
[x] Update README to make the use case more clear
[x] Creating DOCUMENTATION.md with more details to not bloat the README. ~~Created SomeNameFeature.md files, linking ALL relevant documentation and add missing details~~

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.