Table of Contents
Epick was designed to reduce the hassle of having to search up the copy and paste for different emojis whenever you want an emoji in a text document. For instance, adding emojis to blog posts in the terminal can be so much easier when using Epick, as you no longer need to copy and paste a character after searching for the perfect emoji for 5 minutes. All you need to do is run the epick command, find the preferred emoji, and continue coding!
In order to download and start using epick as a terminal command, you must first clone the git repository to your local system.
In order to use epick in a different application, import it by using the import statement:
import "github.com/ethanbaker/epick"
- Go is installed
- Your terminal is able to render emojis
- Clone the repository (
git clone git@github.com:ethanbaker/epick.git) - Navigate into the cloned directory
- Run
go install
Epick should now be installed!
Epick contains multiple pages of different emojis, each of which represents a unique emoji category. These categories are:
- Smileys and Emotion
- People and Body
- Animals and Nature
- Food and Drink
- Travel and Places
- Activities
- Objects
- Symbols
- Flags
You can navigate between different emojis using standard vim bindings (j, j, k, l, g, G).
You can switch between emoji categories by pressing 'C' to go forwards and 'c' to go backwards.
You can quit the app by pressing 'q' or Escape.
You can search for emojis by pressing '?'. This brings up a menu where emojis can be searched for with autocomplete. If you enter a partially incomplete phrase, you can navigate between matching emojis by pressing 'n' to go forwards and 'N' to go backwards.
- Documentation
- Quality-ensurance Refactor
- Testing
See the open issues for a full list of proposed features (and known issues).
For issues and suggestions, please include as much useful information as possible. Review the documentation and make sure the issue is actually present or the suggestion is not included. Please share issues/suggestions on the issue tracker.
For patches and feature additions, please submit them as pull requests. Please adhere to the conventional commits. standard for commit messaging. In addition, please try to name your git branch according to your new patch. These standards are a great guide you can follow.
You can follow these steps below to create a pull request:
- Fork the Project
- Create your Feature Branch (
git checkout -b branch_name) - Commit your Changes (
git commit -m 'commit_message') - Push to the Branch (
git push origin branch_name) - Open a Pull Request
This project uses the Apache 2.0 license.
You can find more information in the LICENSE file.
Ethan Baker - contact@ethanbaker.dev - LinkedIn
Project Link: https://github.com/ethanbaker/epick