nlogo
v1.8.0
Published
A searchable collection of logos for node/npm packages (hosted remotely)
Downloads
4
Readme
NLogo
A searchable collection of logos for node/npm packages
Reasons why more open source projects should have a logo
These are from the top of my head and probably not backed by any science. (PR this to make it more compelling and add citations).
- Logos are good UX, you can generally scan colors + shapes more quickly than read some text.
- Logos can often quickly tell you something about the project
- Logos help you remember a project
- Logos make projects more approachable to beginners/noobs
- i18n friendly
- Having fun, being relatable and expressing personality are awesome (logos can help do this)
PR this please
It's early days and contributions are required to build up a comprehensive list of logos for node/npm packages.
There are two types of contributions that would be super helpful right now:
- Add logos for existing node/npm modules
- Create a logo or request that someone creates a logo for one of your open source node/npm modules
How to use
There are two libraries that you can use, nlogo
or nlogo-images
.
The differences are:
nlogo
: Gives you a remote (on the web) reference to the logosnlogo-images
: Bundles all images and gives you a local (on hard disk) refererence to logos
Be wary of using nlogo-images
because it bundles all of the image files which may add quite a bit of weight to your node_modules
directory.
nlogo
npm install nlogo
const nlogo = require('nlogo');
const req = require('request-promise-native');
const redux = nlogo.get('react-redux');
// => {
// filename: 'redux.svg',
// url: 'https://nlogo.github.io/images/redux.svg',
// author: {
// name: "Matthew Johnston",
// url: "http://thedeskofmatthew.com/"
// }
// }
await req(redux.url);
// => '<svg>…</svg>'
nlogo-images
npm install nlogo-images
const logos = require('nlogo-images');
const { readFile } = require('fs');
const redux = logos.get('react-redux');
// => {
// filename: 'redux.svg',
// path: '/Users/dave/my-site.com/node_modules/nlogo-images/redux.svg',
// url: 'https://nlogo.github.io/images/redux.svg',
// author: {
// name: "Matthew Johnston",
// url: "http://thedeskofmatthew.com/"
// }
// }
await readFile(redux.path, 'utf8');
// => '<svg>…</svg>'
Next goals
- Encourage collaboration between logo designers and devs/maintainers to create logos for their open-source projects
- Make a simple web app frontend that allows you to filter through the logos in this repo
- Add more structure around image formats and dimensions, expose more logo metadata.