added comments (#5)

* added comments

* update workflow to go 1.18

.github/workflows/build.yml

@@ -7,7 +7,7 @@ on:
       - synchronize
 
 env:
-  GO_VERSION: 1.19
+  GO_VERSION: 1.18
 
 jobs:
   unit-tests:

README.md

@@ -9,20 +9,9 @@ A URL shortener library implemented in Go.
 go get github.com/TomerHeber/go-short-url
 ```
 
-## MongoDB
-
-To store the mappings between short urls and their original urls, A MongoDB database is required.
-
-## Development
-
-Install `golangci-lint`:  
-Check [https://golangci-lint.run/usage/install/#local-installation](https://golangci-lint.run/usage/install/#local-installation) for installation instructions.
+## Documentation
 
-Install `pre-commit`:  
-Check [https://pre-commit.com/](https://pre-commit.com/) for installation instructions.
-
-Enable the git pre commit hooks:  
-`pre-commit install `
+Documentation is available at: [https://pkg.go.dev/github.com/TomerHeber/go-short-url](https://pkg.go.dev/github.com/TomerHeber/go-short-url)
 
 ## Example
 
@@ -47,4 +36,19 @@ It's a tiny webserver that generates short urls.
 ```
 docker-compose up -d
 go run ./example/main.go
-```
+```
+
+## MongoDB
+
+To store the mappings between short urls and their original urls, A MongoDB database is required.
+
+## Development
+
+Install `golangci-lint`:  
+Check [https://golangci-lint.run/usage/install/#local-installation](https://golangci-lint.run/usage/install/#local-installation) for installation instructions.
+
+Install `pre-commit`:  
+Check [https://pre-commit.com/](https://pre-commit.com/) for installation instructions.
+
+Enable the git pre commit hooks:  
+`pre-commit install `

config.go

@@ -7,6 +7,8 @@ import (
 	"go.mongodb.org/mongo-driver/x/mongo/driver/connstring"
 )
 
+// Config is used to customize the shortener.
+// To create a config instance use `DefaultConfig()`.
 type Config interface {
 	getConfig() *config
 

short.go

@@ -60,7 +60,7 @@ func NewShortener(config ...Config) (Shortener, error) {
 	var s shortner
 
 	s.host = ci.host
-	s.store, err = NewStore(ci.mongoUri, ci.host)
+	s.store, err = newStore(ci.mongoUri, ci.host)
 	if err != nil {
 		return nil, err
 	}

store.go

@@ -111,7 +111,7 @@ func getMongoCollection(ctx context.Context, database *mongo.Database, name stri
 	return collection, nil
 }
 
-func NewStore(mongoUri string, name string) (Store, error) {
+func newStore(mongoUri string, name string) (Store, error) {
 	ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
 	defer cancel()
 

store_test.go

@@ -40,11 +40,11 @@ func TestStore(t *testing.T) {
 
 	t.Run("NewStore", func(t *testing.T) {
 		uri := getRandomMongoURIForTesting()
-		_, err := NewStore(uri, "short.link")
+		_, err := newStore(uri, "short.link")
 		require.Nil(t, err)
-		_, err = NewStore(uri, "short.com")
+		_, err = newStore(uri, "short.com")
 		require.Nil(t, err)
-		_, err = NewStore(uri, "short.link")
+		_, err = newStore(uri, "short.link")
 		require.Nil(t, err)
 
 		client := mongoDbClientMap[uri]
@@ -64,7 +64,7 @@ func TestStore(t *testing.T) {
 		getStoreHelper := func(t *testing.T) Store {
 			t.Helper()
 			uri := getRandomMongoURIForTesting()
-			s, err := NewStore(uri, collectionName)
+			s, err := newStore(uri, collectionName)
 			require.Nil(t, err)
 			return s
 		}

url_config.go

@@ -5,6 +5,8 @@ import (
 	"time"
 )
 
+// UrlConfig may be used to customize the way a url is shortened.
+// A UrlConfig instance can be created by calling `DefaultUrlConfig()`.
 type UrlConfig interface {
 	getConfig() *urlConfig