Code Monkey home page Code Monkey logo

stringutils's Introduction

Version Test Go Documentation Go Report Card

stringutils

A basic golang package for demonstration purpose. Package currently contains only one function:

func Reverse(s string) (string, error)

Installation

Go to your project root, where go.mod file exists, than grab the library via:

go get github.com/mkdemir/stringutils-demo@latest

Usage

package main

import (
	"fmt"

	"github.com/mkdemir/stringutils-demo"
)

func main(){
	reversed, err := stringutils.Reverse("mkdemir")
	if err != nil {
		log.Fatal(err)
	}    
	fmt.Println(reversed) // ogiv
}

Makefile

make help

Commands usage:

make <command>

commands:

test       run tests
testfuzz   run tests with fuzz (30 seconds)
bench      run benchmark tests
doc        run godoc server at 3000 unless PORT env-var is set
  • make test: Runs tests
  • make testfuzz: Runs Fuzzy tests for 30seconds (go 1.18)
  • make bench: Runs benchmark tests
  • make doc: Runs godoc server on port 3000. Use PORT environment variable for different port -> PORT=4000 make doc

Contributor(s)


Contribute

All PR’s are welcome!

  1. fork (https://github.com/mkdemir/stringutils-demo/fork)
  2. Create your branch (git checkout -b my-feature)
  3. commit yours (git commit -am 'add some functionality')
  4. push your branch (git push origin my-feature)
  5. Than create a new Pull Request!

License

This project is licensed under MIT


This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

stringutils's People

Contributors

mkdemir avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.