https://github.com/zachflower/marquee

:calendar: Writes a message to the GitHub Contributions calendar matrix.
https://github.com/zachflower/marquee

Last synced: about 8 hours ago
JSON representation

:calendar: Writes a message to the GitHub Contributions calendar matrix.

• Host: GitHub
• URL: https://github.com/zachflower/marquee
• Owner: zachflower
• Created: 2015-09-02T04:13:40.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2022-03-21T03:25:16.000Z (over 2 years ago)
• Last Synced: 2024-09-14T22:27:35.575Z (19 days ago)
• Language: JavaScript
• Homepage:
• Size: 43 KB
• Stars: 13
• Watchers: 3
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# ``

`` is a command-line Node.js app that creates back-dated Git commits in

order to write a message on your GitHub contribution summary graph.

## Example

![Marquee Example](/images/example.png)

## Installation

```

npm install github-marquee

```

## Usage

Writing a marquee message to your GitHub contribution summary graph is done in

a few steps.

### Step 1: Create a New Directory

`` is designed to work on a brand new repository. Because we are

manipulating history, it is a *really bad* idea to use this on an existing

repository.

```

$ mkdir hi-there

```

### Step 2: Create Commit Messages

Open up your terminal and use the following syntax to create a commit history

that maps to your message.

```

$ marquee 

```

### Step 3: Create a Public GitHub Repository

`` only creates a contribution history, it does not interface directly

with GitHub. After you've set up your commits, head over to

https://github.com/new and create a new repository.

Be sure to leave "Initialize this repository with a README" unchecked, and do

not add a license or `.gitignore`.

### Step 4: Push Your New Repository

After creating your repository, follow the GitHub instructions to "push an

existing repository from the command line." After pushing your repository, your

GitHub contribution summary graph will be updated immediately.