😂 expand-emoji

expand-emoji is a program that replaces all emoji shortcodes in the given files to their respective emoji characters.

🎯 Goals

This program is only an interface for the kyokomi's emoji library.

🔌 Getting Started

The following instructions will get you a copy of the source code, and help you execute it.

📦 Requirements

This project requires Go.

⚒️ Installation

The first thing to do is to download the project, either by downloading the ZIP file and extract it somewhere in your machine, or by cloning the project with git clone https://github.com/Cynnexis/expand-emoji.git.

The following steps will assume that the current directory is the project root:

go mod tidy
go build

You will find a expand-emoji binary at the root of your project.

🐳 Using Docker

You can build a Docker image to use expand-emoji.

To build the docker image, enter the following command:

make build-docker

Finally, use the image with the following command:

docker run -d \
	--name=expand-emoji \
	-v "/path/to/expand-emoji/README.md:/README.md" \
	cynnexis/expand-emoji \
	/README.md

Note that this README.md contains shortcodes. You can use expand-emoji to replace them with actual emoji.

🏗️ Build With

Go
kyokomi's emoji library

🤝 Contributing

To contribute to this project, please read our CONTRIBUTING.md file.

We also have a code of conduct to help create a welcoming and friendly environment.

✍️ Authors

Please see the CONTRIBUTORS.md file.

📄 License

This project is under the GNU Affero General Public License v3. Please see the LICENSE file for more detail (it's a really fascinating story written in there!).