rog / rog3r

⚡️ A cool guy.

rog3r

API about a cool guy named Rogelio Alberto.

Install

npm install rog3r

Usage

// ES6 modules
import rog3r from 'rog3r'

// For CommonJS you need to require the `default` instance
const rog3r = require('rog3r').default

Get Contact info

Return the content from src/me.json:

console.log(rog3r.info)
/* Return:
{
  github: rog,
  twitter: rog3r,
  ...
}
*/

Get Github activity

Get the github activity from the user specified on: src/me.json.

rog3r.githubActivity()
  .then( activity => {
    console.log(activity)
  })

Hey, I'm a cool person too!

You are right, you're a very cool person too, so you can import the CoolPerson Class and extend with your own data from src/me.json and now you can use the same methods with your own data and build the library.

Building

1. Clone the repo: git clone https://github.com/rog/rog3r.git
2. Install the dependencies: cd rog3r && npm install
3. Use npm run build to build the library on the lib directory.

• Use npm run dev to auto build the library while developing.

• With npm test you can run the test.

• With npm run report you can see the code coverage.

---

License

Released under the Beerware License.