ready for contributors

CONTRIBUTING.md

@@ -0,0 +1,80 @@
+# Contributing to Groq Go SDK
+
+First off, thank you for considering contributing to the Groq Go SDK! It's people like you that make it such a great tool.
+
+## Code of Conduct
+
+By participating in this project, you are expected to uphold our Code of Conduct. Please report unacceptable behavior to [WanSatya](mailto:[email protected]).
+
+## How Can I Contribute?
+
+### Reporting Bugs
+
+This section guides you through submitting a bug report. Following these guidelines helps maintainers and the community understand your report, reproduce the behavior, and find related reports.
+
+- Use a clear and descriptive title for the issue to identify the problem.
+- Describe the exact steps which reproduce the problem in as many details as possible.
+- Provide specific examples to demonstrate the steps.
+
+### Suggesting Enhancements
+
+This section guides you through submitting an enhancement suggestion, including completely new features and minor improvements to existing functionality.
+
+- Use a clear and descriptive title for the issue to identify the suggestion.
+- Provide a step-by-step description of the suggested enhancement in as many details as possible.
+- Provide specific examples to demonstrate the steps.
+
+### Your First Code Contribution
+
+Unsure where to begin contributing? You can start by looking through these `beginner` and `help-wanted` issues:
+
+- Beginner issues - issues which should only require a few lines of code, and a test or two.
+- Help wanted issues - issues which should be a bit more involved than `beginner` issues.
+
+### Pull Requests
+
+- Fill in the required template
+- Do not include issue numbers in the PR title
+- Include screenshots and animated GIFs in your pull request whenever possible.
+- Follow the Go styleguides.
+- Include thoughtfully-worded, well-structured tests.
+- Document new code based on the Documentation Styleguide
+- End all files with a newline
+
+## Styleguides
+
+### Git Commit Messages
+
+- Use the present tense ("Add feature" not "Added feature")
+- Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
+- Limit the first line to 72 characters or less
+- Reference issues and pull requests liberally after the first line
+
+### Go Styleguide
+
+All Go code should adhere to [Go Code Review Comments](https://github.com/golang/go/wiki/CodeReviewComments).
+
+Some additional guidelines:
+
+- Use `gofmt` to format your code before committing.
+- Use `golint` and `go vet` to check your code for style mistakes.
+- Aim for clear and idiomatic Go code.
+
+### Documentation Styleguide
+
+- Use [Markdown](https://daringfireball.net/projects/markdown) for documentation.
+- Keep language simple and clear.
+
+## Additional Notes
+
+### Issue and Pull Request Labels
+
+This section lists the labels we use to help us track and manage issues and pull requests.
+
+* `bug` - Issues for bugs in the code
+* `enhancement` - Issues for new features or improvements
+* `documentation` - Issues related to documentation
+* `good first issue` - Good for newcomers
+* `help wanted` - Extra attention is needed
+
+Thank you for contributing to Groq Go SDK!

README.md

@@ -1,6 +1,8 @@
 # Groq Go SDK
 
-This is an unofficial Go SDK for the Groq API. It provides a simple and efficient way to interact with Groq's AI models using Go.
+This is an unofficial Go SDK for the [Groq LPU™ AI inference](https://groq.com/inference). 
+
+It provides a simple and efficient way to interact with Groq's AI models using Go.
 
 ## Project Structure
 
@@ -60,11 +62,11 @@ import (
 )
 
 func init() {
-	// Load the .env file in the current directory
-	err := godotenv.Load()
-	if err != nil {
-			log.Fatal("Error loading .env file")
-	}
+  // Load the .env file in the current directory
+  err := godotenv.Load()
+    if err != nil {
+      log.Fatal("Error loading .env file")
+    }
 }
 
 func main() {

docs/API.md

@@ -0,0 +1 @@
+## API documentation