kopia lustrzana https://github.com/badgen/badgen.net
Update readme things (#28)
- Updates a bit of the wording and some typos. - Extends the Developing section it morepull/29/head
rodzic
1401a1bc0e
commit
05c3f545f4
22
README.md
22
README.md
|
@ -9,21 +9,31 @@ Home of [Badgen](https://badgen.now.sh), fast badge generating service.
|
|||
|
||||
## The Badgen Story
|
||||
|
||||
> That's a service, that's a library, hooorey! -- @olstenlarck
|
||||
> That's a service, that's a library, hooorey! -- [@tunnckoCore](https://twitter.com/tunnckoCore)
|
||||
|
||||
TLDR: Badgen use [badgen](https://github.com/amio/badgen) to generate svg badges on the fly, running on Zeit's [now.sh](https://zeit.co/now), serving behind Now CDN.
|
||||
TLDR: Badgen Service is using [badgen](https://github.com/amio/badgen) to generate svg badges on the fly, running on Zeit's [now.sh](https://zeit.co/now), serving behind Now CDN.
|
||||
|
||||
The [badgen](https://github.com/amio/badgen) library was born as an exploration of "is it possible to generate badge svg markup directly with JavaScript(without using pdfkit/canvas/puppeteer to measure text length)?". Result is better than I expected, Verdana(the de-facto font for badges) text width can be calculated precisely with a prebuilt [char-width-table](https://github.com/amio/badgen/blob/master/lib/widths-verdana-11.json), even no need to worried about kerning 🤯
|
||||
The [badgen](https://github.com/amio/badgen) library was born as an exploration of "is it possible to generate badge svg markup directly with JavaScript(without using pdfkit/canvas/puppeteer to measure text length)?". Result is better than I expected, Verdana(the de-facto font for badges) text width can be calculated precisely with a prebuilt [char-width-table](https://github.com/amio/badgen/blob/master/lib/widths-verdana-11.json), even no need to worry about kerning 🤯
|
||||
|
||||
Then cames Badgen. I had a good time with [shields.io](https://shields.io)(and earlier [badge.fury.io](https://badge.fury.io)), but as time goes by Shields gets slower, leaves more and more broken badges in READMEs. Badgen is trying to be a fast alternative with simplicity and flexibility.
|
||||
And so, Badge Service was born. I had a good time with [shields.io](https://shields.io)(and earlier [badge.fury.io](https://badge.fury.io)), but as time goes by Shields gets slower, leaves more and more broken badges in READMEs. Badgen is trying to be a fast alternative with simplicity and flexibility. Its codebase is well structured and fun to develop - it is pretty easy to add badge(s) for new service(s).
|
||||
|
||||
At beginning I was considering between [now.sh](https://zeit.co/now) and [Google Cloud Functions](https://cloud.google.com/functions/). Then Zeit released [Now CDN](https://zeit.co/blog/now-cdn) on the same day as [badgen.now.sh](https://badgen.now.sh)'s reveal, what a fate! Born to fall in love 😘. With Now CDN, Badgen removed all builtin cache while serving faster than ever. Now Badgen has settled it's home on Zeit's Now.
|
||||
At the beginning I was considering between [now.sh](https://zeit.co/now) and [Google Cloud Functions](https://cloud.google.com/functions/). Then Zeit released [Now CDN](https://zeit.co/blog/now-cdn) on the same day as [badgen.now.sh](https://badgen.now.sh)'s reveal, what a fate! Born to fall in love 😘. Choosing to base such service on Zeit's Now CDN is the perfect choice, because we can stop thinking about caching and scalability issues. Badgen is the fastest possible badge generating service out there. It's fast, because Now is fast. It's amazing, because Now is amazing. It's globally distributed and cached, because of Now.
|
||||
|
||||
Thanks to awesome people's help, Badgen are getting better and better. Welcome to join us, let's build the best badge service in the universe 🔥
|
||||
|
||||
## Developing
|
||||
|
||||
- `npm start` or better if you have nodemon: `nodemon service.js`
|
||||
We are using StandardJS style, so don't worry. If you have ESLint plugin on your editor and have autofix enabled, then great - you write code and it's valid. Otherwise, installing ESLint plugin for your favorite editor is highly recommended, because it will help you not only here, but with contributions to other projects too.
|
||||
|
||||
If a service you are using is still missing here, we welcome new contirbutions. Check out the PRs that was made and how easy it was:
|
||||
|
||||
- [#3 - Support for Chrome Web Store badges](https://github.com/amio/badgen-service/pull/3)
|
||||
- [#15 - Support for GitHub badges](https://github.com/amio/badgen-service/pull/15)
|
||||
- [#16 - Support for CodeCov coverage badge](https://github.com/amio/badgen-service/pull/16)
|
||||
|
||||
Basically, you need to add a file in `lib/live-fns/[name-of-service].js` and that's it.
|
||||
|
||||
To ensure that your addition is working correctly start the development server with `npm run dev`.
|
||||
|
||||
## About
|
||||
|
||||
|
|
Plik diff jest za duży
Load Diff
|
@ -6,6 +6,7 @@
|
|||
"license": "ISC",
|
||||
"scripts": {
|
||||
"lint": "standard",
|
||||
"dev": "nodemon service.js",
|
||||
"start": "node service.js",
|
||||
"predeploy": "now rm badgen-service --safe -y -T badgen || true",
|
||||
"deploy": "now -T badgen --public && now -T badgen alias"
|
||||
|
@ -20,6 +21,7 @@
|
|||
"serve-marked": "0.2.0"
|
||||
},
|
||||
"devDependencies": {
|
||||
"nodemon": "^1.18.3",
|
||||
"standard": "^11.0.1"
|
||||
},
|
||||
"eslintConfig": {
|
||||
|
|
Ładowanie…
Reference in New Issue