Repo Card =========================================================================== Give your repos some freshness with a Repo Card. I often get lazy adding a profile to my repositories, especially when I'd like for them to get forked, starred, etc. If you've been there, then Repo Cards are for you. ## Demo Here's one of my own repos with one: 2048 Cube ## Usage You can add a repo card in many different ways. Choose one that's easiest for you: Reference the script file via the CDN (not fast, yet) ```javascript ``` Install via Bower ```bash $ bower install repo-card --save ``` Install via NPM ```bash $ npm install repo-card --save ``` Then, you simply configure the Repo card with your info ```javascript // Once sourced from either a CDN or locally, you use the data-attributes to configure the repo card ``` Or, you configure it within your app as seen in the `script` tag below ```javascript ``` ## Options Here are some options that you can set within the `data-attrbutes` (e.g. `data-info="some information`) or in your app. - `repo`: The name of the repo - `theme`: There's only one theme right now (`doodle`), however, I'd love more themes. Check out the `themes` folder or reach out if you'd like assistance in contributing - `username`: Your Github username - `title`: A title for the repo card - `subtitle`: A subtitle for the repo card - `info`: Some information you'd like to include about your project - `background`: Set the background (it accepts CSS, so HEX, RGB or even an image, `url(...)`, works - `thumb`: Set the thumbnail (it accepts CSS, so HEX, RGB or even an image, `url(...)`, works - `position`: The card is currently set to `fixed` position, so you can change its position (e.g. `position: { bottom: 15, left: 15 }` ## Coming - More themes (would love your help on this) - GUI dashboard for configuring the Repo Card - Animations to have the repo card hide away with interactions (e.g. `scroll`) - NPM, Browserify, Webpack, etc. builds? ## Questions Please use the issues page with any questions/concerns. If you like this idea and find it useful, please share the project as I'd love the help :)