Skip to content

Commit

Permalink
chore: improve readmes of tools packages
Browse files Browse the repository at this point in the history
  • Loading branch information
sergiohgz committed Mar 27, 2020
1 parent cacb243 commit a93d073
Show file tree
Hide file tree
Showing 7 changed files with 30 additions and 14 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ We have three kind of packages, separated as:

- core: the main packages for the project
- plugins: plugins created for Verdaccio
- tools: our own packages for tools like ESLint or Babel
- [tools](tools): our own packages for tools like ESLint or Babel

## Contributing

Expand Down
Empty file removed tools/README.md
Empty file.
10 changes: 9 additions & 1 deletion tools/babel-preset/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
# @verdaccio/babel-preset

[![@verdaccio/babel-preset (latest)](https://img.shields.io/npm/v/@verdaccio/babel-preset/latest.svg)](https://www.npmjs.com/package/@verdaccio/babel-preset)
[![Node version (latest)](https://img.shields.io/node/v/@verdaccio/babel-preset/latest.svg)](https://www.npmjs.com/package/@verdaccio/babel-preset)
[![Dependencies](https://img.shields.io/david/verdaccio/monorepo?path=tools%2Fbabel-preset)](https://david-dm.org/verdaccio/monorepo/master?path=tools%2Fbabel-preset)
[![DevDependencies](https://img.shields.io/david/dev/verdaccio/monorepo?path=tools%2Fbabel-preset)](https://david-dm.org/verdaccio/monorepo/master?path=tools%2Fbabel-preset&type=dev)
[![MIT](https://img.shields.io/github/license/verdaccio/monorepo.svg)](./LICENSE)

Configurable Babel preset for Verdaccio projects

## Usage
Expand Down Expand Up @@ -36,4 +42,6 @@ Enable debug
}
```

@verdaccio/babel-preset is a open source project with [MIT license](LICENSE)
## License

This is an open source project under [MIT license](./LICENSE)
2 changes: 1 addition & 1 deletion tools/eslint-config/LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2019 Verdaccio
Copyright (c) 2020 Verdaccio

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
7 changes: 6 additions & 1 deletion tools/eslint-config/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# @verdaccio/eslint-config

[![@verdaccio/eslint-config (latest)](https://img.shields.io/npm/v/@verdaccio/eslint-config/latest.svg)](https://www.npmjs.com/package/@verdaccio/eslint-config)
[![Node version (latest)](https://img.shields.io/node/v/@verdaccio/eslint-config/latest.svg)](https://www.npmjs.com/package/@verdaccio/eslint-config)
[![Dependencies](https://img.shields.io/david/verdaccio/monorepo?path=tools%2Feslint-config)](https://david-dm.org/verdaccio/monorepo/master?path=tools%2Feslint-config)
[![MIT](https://img.shields.io/github/license/verdaccio/monorepo.svg)](./LICENSE)

ESLint shareable configuration for Verdaccio that uses Typescript

```
Expand All @@ -20,4 +25,4 @@ ESLint shareable configuration for Verdaccio that uses Typescript

## License

[MIT](http://www.opensource.org/licenses/mit-license.php)
This is an open source project under [MIT license](./LICENSE)
8 changes: 7 additions & 1 deletion tools/eslint-plugin-verdaccio/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
# eslint-plugin-verdaccio

[![eslint-plugin-verdaccio (latest)](https://img.shields.io/npm/v/eslint-plugin-verdaccio/latest.svg)](https://www.npmjs.com/package/eslint-plugin-verdaccio)
[![Node version (latest)](https://img.shields.io/node/v/eslint-plugin-verdaccio/latest.svg)](https://www.npmjs.com/package/eslint-plugin-verdaccio)
[![Dependencies](https://img.shields.io/david/verdaccio/monorepo?path=tools%2Feslint-plugin-verdaccio)](https://david-dm.org/verdaccio/monorepo/master?path=tools%2Feslint-plugin-verdaccio)
[![DevDependencies](https://img.shields.io/david/dev/verdaccio/monorepo?path=tools%2Feslint-plugin-verdaccio)](https://david-dm.org/verdaccio/monorepo/master?path=tools%2Feslint-plugin-verdaccio&type=dev)
[![MIT](https://img.shields.io/github/license/verdaccio/monorepo.svg)](./LICENSE)

verdaccio code guidelines

## Installation
Expand Down Expand Up @@ -50,4 +56,4 @@ Then configure the rules you want to use under the rules section.

## License

[MIT](http://www.opensource.org/licenses/mit-license.php)
This is an open source project under [MIT license](./LICENSE)
15 changes: 6 additions & 9 deletions tools/testing-utilities/README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,9 @@
# Testing Utilities
# @verdaccio/testing-utilities

[![CircleCI](https://circleci.com/gh/verdaccio/testing-utilities.svg?style=svg)](https://circleci.com/gh/verdaccio/@verdaccio/testing-utilities)
[![codecov](https://codecov.io/gh/verdaccio/testing-utilities/branch/master/graph/badge.svg)](https://codecov.io/gh/verdaccio/testing-utilities)
[![verdaccio (latest)](https://img.shields.io/npm/v/@verdaccio/testing-utilities/latest.svg)](https://www.npmjs.com/package/@verdaccio/testing-utilities)
[![backers](https://opencollective.com/verdaccio/tiers/backer/badge.svg?label=Backer&color=brightgreen)](https://opencollective.com/verdaccio)
[![discord](https://img.shields.io/discord/388674437219745793.svg)](http://chat.verdaccio.org/)
![MIT](https://img.shields.io/github/license/mashape/apistatus.svg)
[![node](https://img.shields.io/node/v/@verdaccio/testing-utilities/latest.svg)](https://www.npmjs.com/package/@verdaccio/testing-utilities)
[![@verdaccio/testing-utilities (latest)](https://img.shields.io/npm/v/@verdaccio/testing-utilities/latest.svg)](https://www.npmjs.com/package/@verdaccio/testing-utilities)
[![Node version (latest)](https://img.shields.io/node/v/@verdaccio/testing-utilities/latest.svg)](https://www.npmjs.com/package/@verdaccio/testing-utilities)
[![DevDependencies](https://img.shields.io/david/dev/verdaccio/monorepo?path=tools%2Ftesting-utilities)](https://david-dm.org/verdaccio/monorepo/master?path=tools%2Ftesting-utilities&type=dev)
[![MIT](https://img.shields.io/github/license/verdaccio/monorepo.svg)](./LICENSE)


This project provides a list of helpers to be reused for unit testing.
Expand All @@ -20,4 +17,4 @@ These methods are intended to generate package metadata for multiples usage in t

## License

MIT (http://www.opensource.org/licenses/mit-license.php)
This is an open source project under [MIT license](./LICENSE)

0 comments on commit a93d073

Please sign in to comment.