https://github.com/motemen/git-hub-sync-repo-info

Synchronize .git/description and .git/homepage files with GitHub repository's info
https://github.com/motemen/git-hub-sync-repo-info

Last synced: about 2 months ago
JSON representation

Synchronize .git/description and .git/homepage files with GitHub repository's info

• Host: GitHub
• URL: https://github.com/motemen/git-hub-sync-repo-info
• Owner: motemen
• License: mit
• Created: 2014-06-03T00:42:15.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2014-06-03T05:00:01.000Z (over 10 years ago)
• Last Synced: 2024-10-15T15:31:24.527Z (3 months ago)
• Language: Ruby
• Homepage:
• Size: 137 KB
• Stars: 5
• Watchers: 5
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
git-hub-sync-repo-info

======================

git-hub-sync-repo-info synchronizes several local files under .git/ with GitHub repository metadata.

Currently files below are used:

 - `.git/description` for repository description

 - `.git/homepage` for repository website (homepage)

Example Usage

-------------

```

% echo "Synchronize .git/description and .git/homepage files with GitHub repository's info" > .git/description 

% git hub-sync-repo-info

# description:

#   local  = Synchronize .git/description and .git/homepage files with GitHub repository's info

#   remote = 

# homepage:

#   local  = 

#   remote = http://www.example.com/

Updated .git/homepage: [http://www.example.com/]

Updated remote description: [Synchronize .git/description and .git/homepage files with GitHub repository's info]

```

How To Use It

-------------

 1. [Generate a GitHub personal access token](https://github.com/settings/tokens/new)

 2. Store that token

        % git config --global hub-sync-repo-info.token TOKEN

 3. Write .git/description or .git/homepage if you want to update them

 4. Run `git-hub-sync-repo-info`