Merge pull request #4 from ankit-amazon/readme-update

Update README.md

Author: yanjunw-amazon

README.md

@@ -1,17 +1,24 @@
-## My Project
+## Amazon CodeGuru Golang Detector Examples
 
-TODO: Fill this README out!
+Amazon CodeGuru is an AWS service that uses program analysis and machine learning to detect potential defects that are difficult for developers to find and offers suggestions for improvement. 
+For more information about how to set up and use CodeGuru, see the [Amazon CodeGuru User Guide](https://docs.aws.amazon.com/codeguru/).
 
-Be sure to:
+This repo demonstrates some of CodeGuru's Golang detectors. For more descriptions of each detector, see our [Detector Library](https://docs.aws.amazon.com/codeguru/detector-library/index.html). 
 
-* Change the title in this README
-* Edit your repository description on GitHub
+PLEASE NOTE: This repo is for demonstration purpose only. It is meant to educate people about 'security flaws'. The code examples contain vulnerable code and should not be used for real-word purposes.
 
-## Security
+## Getting Help
+
+Use the community resources below for getting help with AWS CodeGuru.
+
+- Use GitHub issues to report bugs and request features.
+- Open a support ticket with [AWS Support](https://docs.aws.amazon.com/awssupport/latest/user/getting-started.html).
+- For contributing guidelines, refer to [CONTRIBUTING](https://github.com/aws-samples/amazon-codeguru-reviewer-python-detectors/blob/main/CONTRIBUTING.md).
+
+## Contributing
 
 See [CONTRIBUTING](CONTRIBUTING.md#security-issue-notifications) for more information.
 
 ## License
 
-This project is licensed under the Apache-2.0 License.
-
+This project is licensed under the Apache-2.0 License. See the [LICENSE](LICENSE) file.