# README
words - word metrics from mixed-locale content
words is a package for counting the numbers of words and providing simple metrics like estimated reading times.
Installation
> go get github.com/go-corelibs/words@latest
Examples
Count
func main() {
text := "さらに「やり遂げる」ためのEnjin"
count := words.Count(text)
// count == 12
fmt.Printf("There are %d words in %q\n", count, text)
}
Go-CoreLibs
Go-CoreLibs is a repository of shared code between the Go-Curses and Go-Enjin projects.
License
Copyright 2023 The Go-CoreLibs Authors
Licensed under the Apache License, Version 2.0 (the "License");
you may not use file except in compliance with the License.
You may obtain a copy of the license at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
# Functions
Count returns the total number of parsed words using the Default Words configuration.
Default returns a new Words instance configured with sane defaults.
List returns a list of words that were separated by spaces using the Default Words configuration.
Metrics parses the contents and returns some interesting ReadingMetrics using the Default Words configuration.
Parse returns the list of parsed words using the Default Words configuration.
Range iterates over the list of parsed words using the Default Words configuration.
Search performs a very simple keyword search of the content using the Default Words configuration.
# Constants
AverageWordsPerMinute is the words per minute read by average adults.
RelaxedWordsPerMinute is an estimation of words per minute read by older children and tired adults looking at monitors and screens all day.
# Variables
DefaultPunctuation is a hard-coded list of the most common characters that are not counted as words.
# Structs
ReadingMetrics is a data structure returned by the Words.Metrics method.
Words is the definition for running customized word operations and is the implementation driving the normal package functions.