Skip to content

Commit 3f760a5

Browse files
authored
Add authentic 1FE logos, badges, keywords and descriptions to all packages (#97)
- Add local 1FE logo SVG to each package assets folder - Add professional badges (npm version, MIT license, community) - Add SEO keywords for npm discoverability - Add descriptive package descriptions - Fix badge links to point to npm package pages - Create changeset for patch version bumps - Update documentation links and add community sections
1 parent afc0532 commit 3f760a5

File tree

13 files changed

+172
-2
lines changed

13 files changed

+172
-2
lines changed

.changeset/patch-all-packages.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
---
2+
'@1fe/server': patch
3+
'@1fe/shell': patch
4+
'@1fe/cli': patch
5+
'@1fe/create-1fe-app': patch
6+
---
7+
8+
Manual patch version bump for all packages

packages/1fe-server/README.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
1+
![1FE Logo](./assets/1fe-logo.svg)
2+
13
# @1fe/server
24

5+
[![npm version](https://badge.fury.io/js/@1fe%2Fserver.svg)](https://www.npmjs.com/package/@1fe/server) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Join the community](https://img.shields.io/badge/Join%20the%20community-1fe.com-blue)](https://1fe.com)
6+
37
Express server that serves as the backbone of a 1fe instance, handling dynamic configuration, widget loading, and platform services.
48

59
Follow our documentation [here](https://1fe.com/start-here/) to get started with your own 1fe instance.
@@ -53,13 +57,17 @@ app.listen(3000, () => {
5357
});
5458
```
5559

56-
To learn more, follow the reference guide [here](https://1fe.com/api-reference/1fe-server-reference/)
60+
To learn more, follow the reference guide [here](https://1fe.com/reference/1fe-server-reference/)
5761

5862
## Related Packages
5963

6064
- **[@1fe/shell](https://www.npmjs.com/package/@1fe/shell)** - Application shell and platform utilities
6165
- **[@1fe/cli](https://www.npmjs.com/package/@1fe/cli)** - CLI tools for widget development
6266

67+
## Community
68+
69+
If you have questions or want to discuss this project, please visit the [Issues](https://github.com/docusign/1fe/issues) or [Discussions](https://github.com/docusign/1fe/discussions) pages in our monorepo.
70+
6371
## License
6472

6573
MIT © Docusign Inc.
Lines changed: 20 additions & 0 deletions
Loading

packages/1fe-server/package.json

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,18 @@
11
{
22
"name": "@1fe/server",
33
"version": "0.1.2",
4+
"description": "Server-side runtime and utilities for 1FE applications",
5+
"keywords": [
6+
"1fe",
7+
"frontend",
8+
"server",
9+
"express",
10+
"middleware",
11+
"micro-frontend",
12+
"runtime",
13+
"csp",
14+
"security"
15+
],
416
"license": "MIT",
517
"sideEffects": false,
618
"files": [

packages/1fe-shell/README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
1+
![1FE Logo](./assets/1fe-logo.svg)
2+
13
# @1fe/shell
24

5+
[![npm version](https://badge.fury.io/js/@1fe%2Fshell.svg)](https://www.npmjs.com/package/@1fe/shell) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Join the community](https://img.shields.io/badge/Join%20the%20community-1fe.com-blue)](https://1fe.com)
6+
37
Application shell providing common UI components, layout, and platform utilities for 1fe widgets.
48

59
Follow our documentation [here](https://1fe.com/start-here/) to learn more about 1fe and how the shell works.
@@ -60,6 +64,10 @@ export default function MyWidget() {
6064
- **[@1fe/server](https://www.npmjs.com/package/@1fe/server)** - Express server for 1fe instances
6165
- **[@1fe/cli](https://www.npmjs.com/package/@1fe/cli)** - CLI tools for widget development
6266

67+
## Community
68+
69+
If you have questions or want to discuss this project, please visit the [Issues](https://github.com/docusign/1fe/issues) or [Discussions](https://github.com/docusign/1fe/discussions) pages in our monorepo.
70+
6371
## License
6472

6573
MIT © Docusign Inc.
Lines changed: 20 additions & 0 deletions
Loading

packages/1fe-shell/package.json

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,19 @@
11
{
22
"name": "@1fe/shell",
33
"version": "0.1.2",
4+
"description": "Frontend shell and runtime for 1FE micro-frontend applications",
5+
"keywords": [
6+
"1fe",
7+
"frontend",
8+
"shell",
9+
"micro-frontend",
10+
"react",
11+
"runtime",
12+
"platform",
13+
"widgets",
14+
"routing",
15+
"event-bus"
16+
],
417
"license": "MIT",
518
"sideEffects": false,
619
"files": [

packages/cli/README.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,12 @@
1+
![1FE Logo](./assets/1fe-logo.svg)
2+
13
# @1fe/cli
24

5+
[![npm version](https://badge.fury.io/js/@1fe%2Fcli.svg)](https://www.npmjs.com/package/@1fe/cli) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Join the community](https://img.shields.io/badge/Join%20the%20community-1fe.com-blue)](https://1fe.com)
6+
37
Command-line tools for building, developing, and validating widgets within the 1fe ecosystem.
48

5-
To learn more about what cli has to offer, read through the reference [here](https://1fe.com/api-reference/1fe-cli-reference/)
9+
To learn more about what cli has to offer, read through the reference [here](https://1fe.com/reference/1fe-config-reference/)
610

711
## Installation
812

@@ -42,6 +46,10 @@ The `@1fe/cli` package provides essential development tools for 1fe widgets:
4246
- **[@1fe/shell](https://www.npmjs.com/package/@1fe/shell)** - Application shell and platform utilities
4347
- **[@1fe/server](https://www.npmjs.com/package/@1fe/server)** - Express server for 1fe instances
4448

49+
## Community
50+
51+
If you have questions or want to discuss this project, please visit the [Issues](https://github.com/docusign/1fe/issues) or [Discussions](https://github.com/docusign/1fe/discussions) pages in our monorepo.
52+
4553
## License
4654

4755
MIT © Docusign Inc.

packages/cli/assets/1fe-logo.svg

Lines changed: 20 additions & 0 deletions
Loading

packages/cli/package.json

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,18 @@
11
{
22
"name": "@1fe/cli",
33
"description": "CLI tools for 1FE development and build infrastructure.",
4+
"keywords": [
5+
"1fe",
6+
"cli",
7+
"frontend",
8+
"build",
9+
"development",
10+
"micro-frontend",
11+
"tools",
12+
"webpack",
13+
"typescript",
14+
"contracts"
15+
],
416
"version": "0.1.1",
517
"bin": {
618
"1fe-cli": "./dist/index.js"

0 commit comments

Comments
 (0)