https://github.com/alexcoder04/friendly

Go utils library
https://github.com/alexcoder04/friendly

friendly go go-friendly golang learning library misc miscellaneous simple utils utils-library

Last synced: about 1 month ago
JSON representation

Go utils library

• Host: GitHub
• URL: https://github.com/alexcoder04/friendly
• Owner: alexcoder04
• License: gpl-3.0
• Created: 2022-07-24T15:08:52.000Z (about 2 years ago)
• Default Branch: v2
• Last Pushed: 2023-10-08T10:26:59.000Z (11 months ago)
• Last Synced: 2024-06-21T21:03:01.665Z (3 months ago)
• Topics: friendly, go, go-friendly, golang, learning, library, misc, miscellaneous, simple, utils, utils-library
• Language: Go
• Homepage:
• Size: 62.5 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        

# Friendly Go

[![License](https://img.shields.io/github/license/alexcoder04/friendly)](https://github.com/alexcoder04/friendly/blob/main/LICENSE)

[![Go Version](https://img.shields.io/github/go-mod/go-version/alexcoder04/friendly)](https://github.com/alexcoder04/friendly/blob/main/go.mod)

[![Lines](https://img.shields.io/tokei/lines/github/alexcoder04/friendly?label=lines)](https://github.com/alexcoder04/friendly/pulse)

[![Release](https://img.shields.io/github/v/release/alexcoder04/friendly?display_name=tag&sort=semver)](https://github.com/alexcoder04/friendly/releases/latest)

[![Stars](https://img.shields.io/github/stars/alexcoder04/friendly)](https://github.com/alexcoder04/friendly/stargazers)

[![Contributors](https://img.shields.io/github/contributors-anon/alexcoder04/friendly)](https://github.com/alexcoder04/friendly/graphs/contributors)

A library with functions I use all the time in my projects.

Also useful if you are starting to learn Go and are annoyed by implementing basic things in your project all the time.

## Install and Use

**Warning:** the `v1` version is deprecated, please use `friendly/v2` instead.

In your project directory, type

```sh

go get github.com/alexcoder04/friendly/v2

# or `go get github.com/alexcoder04/friendly/v2/...` depending on the sub-package you need

```

And then, in your code

```go

package ...

import (

    ...

    "github.com/alexcoder04/friendly/v2"

    "github.com/alexcoder04/friendly/v2/ffiles"

)

...

folder, _ := friendly.Input()

if ffiles.IsDir(folder) {

    friendly.CompressFolder(folder, destination)

}

...

```

## Documentation

The documentation can be found on `pkg.go.dev`:

 - [`alexcoder04/friendly/v2`](https://pkg.go.dev/github.com/alexcoder04/friendly/v2)

 - [`alexcoder04/friendly/v2/ffiles`](https://pkg.go.dev/github.com/alexcoder04/friendly/v2/ffiles)

 - [`alexcoder04/friendly/v2/flinux`](https://pkg.go.dev/github.com/alexcoder04/friendly/v2/flinux)

## Contributing

If you use this library and are missing some feature - don't hesitate to open a

pull request or an issue, I'm always looking forward to improve this project!