Skip to content

Commit 883dd1b

Browse files
committed
Add README files templates to packages
1 parent 36d5016 commit 883dd1b

File tree

4 files changed

+90
-3
lines changed

4 files changed

+90
-3
lines changed

README.md

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,19 @@
1-
# microfront-core
1+
# microfront-toolset
22

3-
Microfrontend lightweight core library
3+
Microfrontend toolset
4+
5+
# @redneckz/microfront-core
6+
7+
[Microfrontend Core Library](./packages/microfront-core/README.md)
8+
9+
# @redneckz/module-federation-utils
10+
11+
[Webpack Module Federation Utils](./packages/module-federation-utils/README.md)
12+
13+
# Examples
14+
15+
TODO
16+
17+
# License
18+
19+
[MIT](http://vjpr.mit-license.org)

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"name": "microfront-core",
2+
"name": "microfront-toolset",
33
"description": "Microfrontend libraries",
44
"private": true,
55
"license": "MIT",

packages/microfront-core/README.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# @redneckz/microfront-core
2+
3+
Microfrontend Core Library
4+
5+
[![NPM Version][npm-image]][npm-url]
6+
[![Build Status][build-image]][build-url]
7+
[![Coverage Status][coveralls-image]][coveralls-url]
8+
[![Bundle size][bundlephobia-image]][bundlephobia-url]
9+
10+
# Installation
11+
12+
```bash
13+
$ npm install --save @redneckz/microfront-core
14+
```
15+
16+
or:
17+
18+
```bash
19+
$ yarn add @redneckz/microfront-core
20+
```
21+
22+
# Usage
23+
24+
TODO
25+
26+
# License
27+
28+
[MIT](http://vjpr.mit-license.org)
29+
30+
[npm-image]: https://badge.fury.io/js/%40redneckz%2Fmicrofront-core.svg
31+
[npm-url]: https://www.npmjs.com/package/%40redneckz%2Fmicrofront-core
32+
[build-image]: https://cloud.drone.io/api/badges/redneckz/microfront-core/status.svg
33+
[build-url]: https://cloud.drone.io/redneckz/microfront-core
34+
[coveralls-image]: https://coveralls.io/repos/github/redneckz/microfront-core/badge.svg?branch=main
35+
[coveralls-url]: https://coveralls.io/github/redneckz/microfront-core?branch=main
36+
[bundlephobia-image]: https://badgen.net/bundlephobia/min/@redneckz/microfront-core
37+
[bundlephobia-url]: https://bundlephobia.com/result?p=@redneckz/microfront-core
Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# @redneckz/module-federation-utils
2+
3+
Webpack Module Federation Utils
4+
5+
[![NPM Version][npm-image]][npm-url]
6+
[![Build Status][build-image]][build-url]
7+
[![Coverage Status][coveralls-image]][coveralls-url]
8+
9+
# Installation
10+
11+
```bash
12+
$ npm install --save-dev @redneckz/module-federation-utils
13+
```
14+
15+
or:
16+
17+
```bash
18+
$ yarn add -D @redneckz/module-federation-utils
19+
```
20+
21+
# Usage
22+
23+
TODO
24+
25+
# License
26+
27+
[MIT](http://vjpr.mit-license.org)
28+
29+
[npm-image]: https://badge.fury.io/js/%40redneckz%2Fmodule-federation-utils.svg
30+
[npm-url]: https://www.npmjs.com/package/%40redneckz%2Fmodule-federation-utils
31+
[build-image]: https://cloud.drone.io/api/badges/redneckz/module-federation-utils/status.svg
32+
[build-url]: https://cloud.drone.io/redneckz/module-federation-utils
33+
[coveralls-image]: https://coveralls.io/repos/github/redneckz/module-federation-utils/badge.svg?branch=main
34+
[coveralls-url]: https://coveralls.io/github/redneckz/module-federation-utils?branch=main

0 commit comments

Comments
 (0)