docs: added README.md

[bkrukowski]

Summary by Sourcery

Documentation:

• Add comprehensive documentation to the README.md, detailing the features, installation, usage examples, and advanced operations of the Go library for slice manipulation.

[sourcery-ai]

Reviewer's Guide by Sourcery

This PR adds comprehensive documentation to the project by introducing a detailed README.md file. The documentation covers the library's features, installation process, and provides extensive usage examples with code snippets for various slice operations.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change	Details	Files
Added comprehensive documentation structure	Added introduction and feature overview section Added installation instructions Added license information	README.md
Added detailed code examples and usage documentation	Added examples for basic slice creation and initialization Added examples for push/pop and unshift/shift operations Added examples for element deletion and modification Added examples for advanced operations (filter, reverse, sort, shuffle) Added examples for safe indexing with negative indexes Added documentation for utility methods	README.md

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time. You can also use
  this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

Hey @bkrukowski - I've reviewed your changes - here's some feedback:

Overall Comments:

• Please update the installation instructions with the correct repository path instead of 'yourusername'.
• Consider making error handling consistent across all examples - some examples ignore errors while others handle them. It would be better to demonstrate proper error handling throughout.

Here's what I looked at during the review

• 🟢 General issues: all looks good
• 🟢 Security: all looks good
• 🟢 Testing: all looks good
• 🟢 Complexity: all looks good
• 🟡 Documentation: 1 issue found

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

[bkrukowski]

@sourcery-ai review

[sourcery-ai]

Hey @bkrukowski - I've reviewed your changes - here's some feedback:

Overall Comments:

• The import path in the first example uses 'github.com/yourusername/slice' but should be 'github.com/go-slice/slice' to match the actual repository

Here's what I looked at during the review

• 🟢 General issues: all looks good
• 🟢 Security: all looks good
• 🟢 Testing: all looks good
• 🟢 Complexity: all looks good
• 🟡 Documentation: 2 issues found

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

[bkrukowski]

@sourcery-ai review

[sourcery-ai]

Hey @bkrukowski - I've reviewed your changes and they look great!

Here's what I looked at during the review

• 🟢 General issues: all looks good
• 🟢 Security: all looks good
• 🟢 Testing: all looks good
• 🟢 Complexity: all looks good
• 🟡 Documentation: 3 issues found

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

[bkrukowski]

@sourcery-ai review

[sourcery-ai]

Hey @bkrukowski - I've reviewed your changes - here's some feedback:

Overall Comments:

• Consider adding contribution guidelines and information about how to report issues to make it easier for others to contribute to the project.
• It would be helpful to include information about performance characteristics and any limitations developers should be aware of when using the library.

Here's what I looked at during the review

• 🟢 General issues: all looks good
• 🟢 Security: all looks good
• 🟢 Testing: all looks good
• 🟢 Complexity: all looks good
• 🟢 Documentation: all looks good

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}