Transfer repo to DIMO

.golangci.yml

@@ -5,7 +5,7 @@ linters-settings:
   gocyclo:
     min-complexity: 15
   goimports:
-    local-prefixes: github.com/KevinJoiner/mnemonic
+    local-prefixes: github.com/DIMO-Network/mnemonic
   govet:
     check-shadowing: true
   misspell:

README.md

@@ -1,8 +1,8 @@
 # Mnemonic
 
 ![GitHub license](https://img.shields.io/badge/license-Apache%202.0-blue.svg)
-[![GoDoc](https://godoc.org/github.com/KevinJoiner/mnemonic?status.svg)](https://godoc.org/github.com/KevinJoiner/mnemonic)
-[![Go Report Card](https://goreportcard.com/badge/github.com/KevinJoiner/mnemonic)](https://goreportcard.com/report/github.com/KevinJoiner/mnemonic)
+[![GoDoc](https://godoc.org/github.com/DIMO-Network/mnemonic?status.svg)](https://godoc.org/github.com/DIMO-Network/mnemonic)
+[![Go Report Card](https://goreportcard.com/badge/github.com/DIMO-Network/mnemonic)](https://goreportcard.com/report/github.com/DIMO-Network/mnemonic)
 ## Overview
 
 The Mnemonic package provides a flexible and customizable way to encode data into a mnemonic word list. It implements the [BIP-0039](https://github.com/bitcoin/bips/blob/master/bip-0039.mediawiki) specification using [`big.Int`](https://pkg.go.dev/math/big), allowing for the use of arbitrary entropy sizes.
@@ -22,30 +22,39 @@ The Mnemonic package provides a flexible and customizable way to encode data int
 To use this package in your Go project, run the following command:
 
 ```bash
-go get github.com/KevinJoiner/mnemonic
+go get github.com/DIMO-Network/mnemonic
 ```
 
 ### Example Usage
-All Examples can be found in the [go docs](https://godoc.org/github.com/KevinJoiner/mnemonic) or [examples_test.go](./examples_test.go)
+All Examples can be found in the [go docs](https://godoc.org/github.com/DIMO-Network/mnemonic) or [examples_test.go](./examples_test.go)
 
 ```go
 package main
 
 import (
 	"fmt"
-	"github.com/KevinJoiner/mnemonic"
+	"github.com/DIMO-Network/mnemonic"
 )
 
 func main() {
 	// Example usage with a number
-	number := "12345"
-	mnemonic := mnemonic.FromInt(number)
-	fmt.Println("Mnemonic Word List:", mnemonic)
+	id := int32(1)
+	words := mnemonic.FromInt(id)
+	obfuscatedWords := mnemonic.FromInt32WithObfuscation(id)
+	fmt.Println(words)
+	fmt.Println(obfuscatedWords)
+	// Output: [abandon abandon about]
+	// [learn island zoo]
 
 	// Example usage with a word list
-	words := []string{"apple", "banana", "orange"}
-	decodedNumber := mnemonic.ToInt(words)
-	fmt.Println("Int from Word List:", decodedNumber)
+	obfuscatedWords := []string{"learn", "island", "zoo"}
+	deobfuscatedUint, err := mnemonic.ToUint32WithDeobfuscation(obfuscatedWords)
+	if err != nil {
+		panic(err)
+	}
+
+	fmt.Println(deobfuscatedUint)
+	// Output: 1
 }
 ```
 

bip39_test.go

@@ -9,7 +9,7 @@ import (
 	"strings"
 	"testing"
 
-	"github.com/KevinJoiner/mnemonic"
+	"github.com/DIMO-Network/mnemonic"
 )
 
 //go:embed trezorTestVectors.json

examples_test.go

@@ -3,7 +3,7 @@ package mnemonic_test
 import (
 	"fmt"
 
-	"github.com/KevinJoiner/mnemonic"
+	"github.com/DIMO-Network/mnemonic"
 )
 
 func ExampleFromInt() {

go.mod

@@ -1,4 +1,4 @@
-module github.com/KevinJoiner/mnemonic
+module github.com/DIMO-Network/mnemonic
 
 go 1.18
 

mnemonic_test.go

@@ -5,7 +5,7 @@ import (
 	"fmt"
 	"testing"
 
-	"github.com/KevinJoiner/mnemonic"
+	"github.com/DIMO-Network/mnemonic"
 )
 
 var testVectors = trezorVectors{}