https://github.com/hugomd/micro-description
✍️ A microservice to get the description of a GitHub repository
https://github.com/hugomd/micro-description
api description github micro microservice
Last synced: about 1 year ago
JSON representation
✍️ A microservice to get the description of a GitHub repository
- Host: GitHub
- URL: https://github.com/hugomd/micro-description
- Owner: hugomd
- Created: 2017-03-19T02:02:25.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2017-03-21T08:11:13.000Z (about 9 years ago)
- Last Synced: 2025-01-20T14:37:41.012Z (about 1 year ago)
- Topics: api, description, github, micro, microservice
- Language: JavaScript
- Homepage:
- Size: 38.1 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# Micro Description [](https://drone.ii.md/hugomd/micro-description)
A microservice to get the description of a GitHub repository ✍️
# Usage
```
GET https://d.now.sh/USER/REPO
```
# Why?
The description of a GitHub repo is normally the foundation of my projects and is where I narrow my idea down. I tend to use the same description across the `package.json` and `readme.md`, and unfortunately, GitHub doesn't show you the description just after creating a repository.
# Contributing
If you'd like to contribute (you can skip a few of these steps if you'd like 😉):
1. Clone the repo
2. Make a new local branch
3. Change what you'd like
4. Write some tests
5. Make a Pull Request!
✌️
# Deploy
[](https://deploy.now.sh/?repo=https://github.com/hugomd/micro-description)
```
now hugomd/micro-description
```