README.md

Want your project to stand out? Socialify helps you showcase your project to the world by generating a beautiful project image like the one above!

It includes a ton of options including custom logo, description, badges, and many fonts and background patterns to choose from.

Join today!

Usage

Project site: https://socialify.git.ci

Social Image as a Service

Click on the image to use the link anywhere, the image will be programmatically generated with live data. This means the badges will automatically update.

Recommended for README files or img tags.

Image Download

You can download the image as a .png, .jpeg or .webp and use it anywhere in the world!

Recommended for GitHub repository social preview image and other sites that require image upload.

CLI

You can use cli tool mheap/github-social-image to upload social images to all your repos at once.

Examples

Development

• Create a GitHub token from Settings > Developer settings > Personal access tokens, you'll need it in when setting up environemnt variables.

• You'll need the repo scope

• Run the following commands to set up the Development server:

  # Clone
  git clone https://github.com/wei/socialify.git && cd $_
  
  # Set environment variables in .env
  cp .env.example .env
  
  yarn install
  yarn build
  yarn dev

Authors

• @CryogenicPlanet
• @wei

Part of @MLH-Fellowship Pod 1.0.6

License

• MIT

Hosting

SLA

Socialify is under active development. Design and project domain are subject to change without notice.

Please subscribe to #47 if you would like to receive service updates.

Consider downloading the images or self-hosting should this be a problem.

Privacy

Socialify does not collect any personal or identifiable information, we do not use cookies, do not collect emails or anything.

Socialify uses Google Analytics on web pages to understand overall usage. Generated image links do not have any tracking.