@piotrl piotrl released this Feb 17, 2017 · 17 commits to master since this release

Assets 2

This release contains only changes in documentation (in 17 commits - nice 😉)

NPM docs required also update as it had deprecated links and images:
https://www.npmjs.com/package/github-profile-card

@piotrl piotrl released this Dec 18, 2016 · 34 commits to master since this release

Assets 6

We're back after 5 months! Lots of work was made, including completely rewrite project to TypeScript.
Scope of changes qualifies this release to be marked as major.

Plans

Board for release 2.1.x
Main goal is to create webpage where user can configure widget like on current demo page with only reason, that code will be generated.

Webpage requires building layout, I'm not good at that one so it may take a while :)

Second thing to focus is unit testing. It does assure reliability and is must have.

If you have idea how to improve this library, create new issue.

Changelog

Board for release 2.0.x

Major changes:

  • TypeScript + ES2015 ❤️

    Widget had major rewrite with focus on structure and responsibility of components.
    Everything has suitable type (even API responses) and lots of ES2015 features were used.
    Why? For fun and profit.

  • Caching requests

    GitHub limits user to make maximum 60 requests, that may cause problems for users that has lots of repositories or when you often refresh page. With introduced caching, problem is solved.

  • HTML API

    It highly simplifies installation process, all configuration options can be now placed in HTML.
    Not JS initialization required anymore.

  • NPM registry
    Now you can choose if you want to download widget by bower or npm. Check out npm page

Improvments:

  • Calculating TOP languages

    Modified calculation algorithm, now it considers only 10 repositories based on widget sorting (by stars or by update time). I believe this reflects much better current user preferences.

  • Performance
    I've analysed few performance problems. Now widget loads faster and doesn't blink on initialization.

  • Error handling
    Widget now throws error faster if user won't fill required config parameters.

Breaking changes:

Transition is very easy, the best option is just to repeat installation step.

But for matter of clarity, here is list:

  • Dropped v prefix from version number. It's just 2.0.0 instead of v2.0.0

  • Changed configuration options

    • userName changed to username
    • reposheaderText changed to headerText
  • After creating object, you have to call init method like here:

    var widget = new GitHubCard({...});
    widget.init();
    

@piotrl piotrl released this Aug 15, 2016 · 66 commits to master since this release

Assets 4

After last release (2 years ago!), some work was done - yet never released.

Changelog:

  • Complete rewrite
  • Separated rendering from data loading
  • Top languages: All requests are in async mode. Loading time is improved.
  • Put more focus on README

Apart of old stuff, I've written down goals that library might accomplish and updated README (inspiration: How to use GitHub like a proper human being)

For planned development, see next milestones.

@piotrl piotrl released this Aug 10, 2014 · 87 commits to master since this release

Assets 2
v1.1.1

Hotfix. Restore widget variable in library that is used in demo

@piotrl piotrl released this Aug 10, 2014 · 88 commits to master since this release

Assets 2

I've added options to configure your widget:

  • Specify username
  • Choose the way to sort repositories
  • - Repositories with more stars on the top
  • - Lastest updated repositories on top
  • How many repositories should be displayed

I also add interactive demo and start use gulp build system (so you will always can have minified and tested scripts in every release).