username_blacklist

README

username-blacklist

Username Blacklist checks usernames, that you might not want to grant as a username.

Installation

go get github.com/caffeines/username-blacklist

Usage

package main

import (
	"fmt"
	"github.com/caffeines/username-blacklist"
)

func main() {
	blacklisted := username_blacklist.Blacklisted("admin")
	fmt.Println("blacklisted:", blacklisted)
}

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

This project is released under the MPL2.0 License. See the bundled LICENSE file for details.

Credits

• github.com/marteinn/The-Big-Username-Blacklist

Documentation

Overview

Package username_blacklist checks usernames, that you might not want to grant as a username.

Example:

package main

import (
	"fmt"
	"github.com/caffeines/username-blacklist"
)

func main() {
	blacklisted := username_blacklist.Blacklisted("admin")
	fmt.Println("blacklisted:", blacklisted)
}

Requests or bugs? https://github.com/caffeines/username-blacklist/issues

Example

package main

import (
	"fmt"
	username_blacklist "github.com/caffeines/username-blacklist"
)

func main() {
	exists := username_blacklist.Blacklisted("admin")
	fmt.Println(exists)
	exists = username_blacklist.Blacklisted("caffeines")
	fmt.Println(exists)
}

Output:
true
false

Index

• func Blacklisted(username string) bool

Examples

• Package

Functions

func Blacklisted

func Blacklisted(username string) bool

Blacklisted returns true if the username is blacklisted