add link to styleguide

Reviewed-on: #8

manually approving because CI is offline rn for some reason

README.md

@@ -1,11 +1,50 @@
 # mfer
 
-Manifest file generator and checker.
+[mfer](https://git.eeqj.de/sneak/mfer) is a reference implementation library
+and thin wrapper command-line utility written in [Go](https://golang.org)
+and first published in 2022 under the [WTFPL](https://wtfpl.net) (public
+domain) license.  It specifies and generates `.mf` manifest files over a
+directory tree of files to encapsulate metadata about them (such as
+cryptographic checksums or signatures over same) to aid in archiving,
+downloading, and streaming, or mirroring.  The manifest files' data is
+serialized with Google's [protobuf serialization
+format](https://developers.google.com/protocol-buffers).  The structure of
+these files can be found [in the format
+specification](https://git.eeqj.de/sneak/mfer/src/branch/main/mfer/mf.proto)
+which is included in the [project
+repository](https://git.eeqj.de/sneak/mfer).
+
+The current version is pre-1.0 and while the repo was published in 2022,
+there has not yet been any versioned release.  [SemVer](https://semver.org)
+will be used for releases.
+
+This project was started by [@sneak](https://sneak.berlin) to scratch an
+itch in 2022 and is currently a one-person effort, though the goal is for
+this to emerge as a de-facto standard and be incorporated into other
+software.  A compatible javascript library is planned.
 
 # Build Status
 
 [![Build Status](https://drone.datavi.be/api/badges/sneak/mfer/status.svg)](https://drone.datavi.be/sneak/mfer)
 
+# Participation
+
+The community is as yet nonexistent so there are no defined policies or
+norms yet.  Primary development happens on a privately-run Gitea instance at
+[https://git.eeqj.de/sneak/mfer](https://git.eeqj.de/sneak/mfer) and issues
+are [tracked there](https://git.eeqj.de/sneak/mfer/issues).
+
+Changes must always be formatted with a standard `go fmt`, syntactically
+valid, and must pass the linting defined in the repository (presently only
+the `golangci-lint` defaults), which can be run with a `make lint`.  The
+`main` branch is protected and all changes must be made via [pull
+requests](https://git.eeqj.de/sneak/mfer/pulls) and pass CI to be merged.
+Any changes submitted to this project must also be
+[WTFPL-licensed](https://wtfpl.net) to be considered.
+
+Ideally, contributions conform to @sneak's personal 
+[code styleguide](https://git.eeqj.de/sneak/styleguide).
+
 # Problem Statement
 
 Given a plain URL, there is no standard way to safely and programmatically
@@ -170,6 +209,15 @@ regardless of filesystem format.
 Please email [`sneak@sneak.berlin`](mailto:sneak@sneak.berlin) with your
 desired username for an account on this Gitea instance.
 
-I am currently interested in hiring a contractor skilled with the Go
-standard library interfaces to specify this tool in full and develop a
-prototype implementation.
+## Links
+
+* Repo: [https://git.eeqj.de/sneak/mfer](https://git.eeqj.de/sneak/mfer)
+* Issues: [https://git.eeqj.de/sneak/mfer/issues](https://git.eeqj.de/sneak/mfer/issues)
+
+# Authors
+
+* [@sneak <sneak@sneak.berlin>](mailto:sneak@sneak.berlin)
+
+# License
+
+* [WTFPL](https://wtfpl.net)

cmd/mfer/main.go

@@ -3,7 +3,7 @@ package main
 import (
 	"os"
 
-	"sneak.berlin/go/mfer/internal/cli"
+	"git.eeqj.de/sneak/mfer/internal/cli"
 )
 
 var (

go.mod

@@ -1,4 +1,4 @@
-module sneak.berlin/go/mfer
+module git.eeqj.de/sneak/mfer
 
 go 1.17
 

internal/cli/gen.go

@@ -4,9 +4,9 @@ import (
 	"bytes"
 	"path/filepath"
 
+	"git.eeqj.de/sneak/mfer/internal/log"
+	"git.eeqj.de/sneak/mfer/mfer"
 	"github.com/urfave/cli/v2"
-	"sneak.berlin/go/mfer/internal/log"
-	"sneak.berlin/go/mfer/mfer"
 )
 
 func (mfa *CLIApp) generateManifestOperation(ctx *cli.Context) error {

internal/cli/mfer.go

@@ -5,8 +5,8 @@ import (
 	"os"
 	"time"
 
+	"git.eeqj.de/sneak/mfer/internal/log"
 	"github.com/urfave/cli/v2"
-	"sneak.berlin/go/mfer/internal/log"
 )
 
 type CLIApp struct {

mfer/deserialize.go

@@ -6,9 +6,9 @@ import (
 	"errors"
 	"io"
 
+	"git.eeqj.de/sneak/mfer/internal/bork"
+	"git.eeqj.de/sneak/mfer/internal/log"
 	"google.golang.org/protobuf/proto"
-	"sneak.berlin/go/mfer/internal/bork"
-	"sneak.berlin/go/mfer/internal/log"
 )
 
 func (m *manifest) validateProtoOuter() error {

mfer/example_test.go

@@ -4,8 +4,8 @@ import (
 	"bytes"
 	"testing"
 
+	"git.eeqj.de/sneak/mfer/internal/log"
 	"github.com/stretchr/testify/assert"
-	"sneak.berlin/go/mfer/internal/log"
 )
 
 func TestAPIExample(t *testing.T) {

mfer/manifest.go

@@ -10,8 +10,8 @@ import (
 	"path/filepath"
 	"strings"
 
+	"git.eeqj.de/sneak/mfer/internal/log"
 	"github.com/spf13/afero"
-	"sneak.berlin/go/mfer/internal/log"
 )
 
 type manifestFile struct {

mfer/mf.go

@@ -1,3 +0,0 @@
-package mfer
-
-//go:generate protoc ./mf.proto --go_out=paths=source_relative:.

mfer/mfer_test.go

@@ -5,9 +5,9 @@ import (
 	"fmt"
 	"testing"
 
+	"git.eeqj.de/sneak/mfer/internal/log"
 	"github.com/spf13/afero"
 	"github.com/stretchr/testify/assert"
-	"sneak.berlin/go/mfer/internal/log"
 )
 
 // Add those variables as well

mfer/serialize.go

@@ -10,7 +10,7 @@ import (
 	"google.golang.org/protobuf/proto"
 )
 
-// was go-generate protoc --go_out=. --go_opt=paths=source_relative mf.proto
+//go:generate protoc --go_out=. --go_opt=paths=source_relative mf.proto
 
 // rot13("MANIFEST")
 const MAGIC string = "ZNAVSRFG"