Dev

README.md

@@ -1,5 +1,5 @@
-[![Build Status](https://travis-ci.org/gellel/slice.svg?branch=master)](https://travis-ci.org/gellel/slice)
-[![Apache V2 License](https://img.shields.io/badge/license-Apache%20V2-blue.svg)](https://github.com/gellel/slice/blob/master/LICENSE)
+[![Build Status](https://travis-ci.org/lindsaygelle/slice.svg?branch=master)](https://travis-ci.org/lindsaygelle/slice)
+[![Apache V2 License](https://img.shields.io/badge/license-Apache%20V2-blue.svg)](https://github.com/lindsaygelle/slice/blob/master/LICENSE)
 
 # Slice
 
@@ -15,31 +15,29 @@ The slice interfaces do not expose the underlying `slice.Slice` to prevent a mix
 
 The package is built around the Go documentation pattern. Please consider using `godoc` when using this package. If you are using Go 1.12 or earlier, `godoc` should be included. All Go 1.13 users will need to grab this package using the `go get` flow.
 
-## Installing
+## Installation
+Add slice as a dependency to your Go project using the following command:
 
-Use `go get` to retrieve the SDK to add it to your `GOPATH` workspace, or project's Go module dependencies.
-
-```go get github.com/gellel/slice```
-
-To update the SDK use `go get -u` to retrieve the latest version of the SDK.
-
-```go get -u github.com/gellel/slice```
-
-## Dependencies
-
-The SDK includes a vendor folder containing the runtime dependencies of the SDK. The metadata of the SDK's dependencies can be found in the Go module file go.mod.
-
-## Go Modules
+```sh
+go get -u github.com/lindsaygelle/slice
+```
 
-If you are using Go modules, your go get will default to the latest tagged release version of the SDK. To get a specific release version of the SDK use `@<tag>` in your `go get` command.
+## Docker
+You can utilize slice within a Docker container with the provided Dockerfile. Here's how to build and run the container:
 
-```go get github.com/gelle/slice@<version>```
+Building the Docker container.
+```sh
+docker build . -t slice
+```
 
-To get the latest SDK repository change use @latest.
+Developing and running Go from within the Docker container.
+```sh
+docker run -it --rm --name slice slice
+```
 
-## License
+## Docker-compose
+A [`docker-compose.yml`](./docker-compose.yml) file has also been added for convenience.
 
-This SDK is distributed under the Apache License, Version 2.0, see LICENSE for more information.
 
 ## Snippets
 
@@ -51,7 +49,7 @@ package main
 import (
     "fmt"
 
-    "github.com/gellel/slice"
+    "github.com/lindsaygelle/slice"
 )
 
 var (
@@ -91,7 +89,7 @@ A Slice interface implements all methods of slice.Slice.
 ```Go
 
 import (
-    "github.com/gellel/slice"
+    "github.com/lindsaygelle/slice"
 )
 
 func main() {
@@ -115,7 +113,7 @@ This is the pattern implemented by this package and is used for the provided int
 package food
 
 import (
-    "github.com/gellel/slice"
+    "github.com/lindsaygelle/slice"
 )
 
 // Food is a struct that describes food.
@@ -144,3 +142,9 @@ func (f *fooder) Prepend(food ...Food) Fooder {
     return f
 }
 ```
+
+## Contributing
+Contributions to Slice are welcome! If you have any ideas, bug reports, or enhancements, please submit them as GitHub issues or create a pull request with your changes. For major contributions, it is recommended to discuss your ideas first by creating an issue to ensure alignment with the project's goals and direction. Please see the [CONTRIBUTION](./CONTRIBUTING.md) file fore more details.
+
+## License
+Slice is licensed under the MIT License. Feel free to use, modify, and distribute the code within this repository as per the terms of the license. Please see the [LICENSE](./LICENSE) file for more details.