Giter Site home page Giter Site logo

hermes's Introduction

hermes-logo


Hermes is a command-line interface (CLI) application built in Go that accelerates the process of downloading web-optimized Google Font files in the WOFF2 format. Hermes takes an opinionated approach by downloading variable font files, if available. Otherwise, Hermes downloads each individual font weight file separately. Additionally, Hermes generates the necessary CSS code to easily integrate the downloaded fonts into your project.

Features

  • Efficient Font Downloads: Optimizes the download process by retrieving only the necessary font files in WOFF2 format.

  • Variable Font Support: Prioritizes downloading a single variable font file (when available) for efficiency.

  • CSS Integration: Generates CSS code, making it seamless to incorporate the downloaded fonts into your project.

Getting Started

Prerequisites

Hermes requires a Google Fonts API Key. Obtain your key here.

Installation

Install using Homebrew

brew tap cadensstudio/tap && brew install hermes

Download the binary

See releases.

Usage

Ensure you set your Google Fonts API key by running export GFONTS_KEY=<YOUR KEY>.

Run hermes --help to view all available hermes commands:

Usage:
  hermes [command]

Available Commands:
  completion  Generate the autocompletion script for the specified shell
  get         Downloads web-optimized font files for a specified font family
  help        Help about any command
  list        Lists the 10 most trending Google Fonts

Flags:
  -h, --help   help for hermes

Use "hermes [command] --help" for more information about a command.

Contributions

Contributions to Hermes are welcome! Feel free to open issues, submit pull requests, or provide feedback to improve the tool.

Local Dev Setup

  1. Clone the repository:

    git clone https://github.com/cadensstudio/hermes.git
  2. Navigate to the project directory:

    cd hermes
  3. Set your Google Fonts API Key:

    export GFONTS_KEY=<YOUR KEY>
  4. Build Hermes:

    go build
  5. Run Hermes:

    ./hermes get inter

License

This project is licensed under the MIT License - see the LICENSE file for details.

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.