You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+37-23Lines changed: 37 additions & 23 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,15 +17,48 @@ Evergreen represents our commitment to creating cohesive, accessible, and user-f
17
17
-**Efficiency:** Reduces design and development time through reusable patterns and shared resources
18
18
-**Quality:** Maintains high standards as we scale our digital presence and collaborations
19
19
20
-
## Quick start
20
+
## Who should use Evergreen
21
+
22
+
Evergreen serves as a resource for:
23
+
24
+
- WRAP's internal design and development teams
25
+
- Partner organizations collaborating on WRAP initiatives
26
+
- External suppliers and agencies contributing to WRAP projects
27
+
- Anyone building digital experiences within the WRAP ecosystem
28
+
29
+
## How to get started
30
+
31
+
Evergreen provides tools for both designers and developers:
32
+
33
+
-**[Figma Resources](https://www.figma.com/design/yJ6UMIUFdnGkcqwn99oe0d/%F0%9F%8C%B2-Evergreen?node-id=2-2&p=f&t=YNt7unTt6dRbwRy6-0):** Design with our component library, design tokens, and templates to create experiences that align with WRAP's visual identity.
34
+
-**[Components](https://evergreen.wrap.ngo/):** Build interfaces efficiently with our coded components, complete with documentation, usage guidelines, and examples.
35
+
-**[Brand Guidelines](https://brand.wrap.ngo):** Access WRAP's complete brand guidelines on Frontify, including logos, tone of voice, photography direction, and printed media.
36
+
37
+
By using these resources, you can create experiences that feel cohesive and authentic to the WRAP brand while saving time on your projects.
38
+
39
+
## Website installation
40
+
41
+
Evergreen is distributed as an [NPM package](https://www.npmjs.com/package/@wrap.ngo/evergreen?activeTab=readme). The package contains exports for:
42
+
43
+
- Styles (@wrap.ngo/evergreen/styles) CSS to import global Evergreen styles
44
+
- Fonts (@wrap.ngo/evergreen/fonts) optional CSS to import Evergreen fonts
45
+
- Components (@wrap.ngo/evergreen/components) JS to register Evergreen components
46
+
47
+
### No build tools route
21
48
22
-
Install the module.
49
+
Evergreen is packaged to be used directly in the browser, and doesn't require any build.
50
+
51
+
[Here is a Codepen example](https://codepen.io/Dan-Webb/pen/OPymPKX) which shows how a CDN like esm.sh can be used to load Evergreen.
52
+
53
+
### Build tools route
54
+
55
+
First install the NPM package.
23
56
24
57
```bash
25
58
npm install --save @wrap.ngo/evergreen
26
59
```
27
60
28
-
Add the global CSS and JS in your main app file.
61
+
Then, include the global CSS and JS in your main app file.
29
62
30
63
```js
31
64
// Global styles
@@ -46,26 +79,7 @@ Use the components anywhere.
46
79
</evg-button>
47
80
```
48
81
49
-
See the [example directory (`./example`)](https://github.com/wrap-org/evergreen/tree/main/example) for a working code example or head over to the [page setup guide](https://evergreen.wrap.ngo/?path=/docs/guides-page-setup--docs) for information on setting up your first page.
50
-
51
-
## Who should use Evergreen
52
-
53
-
Evergreen serves as a resource for:
54
-
55
-
- WRAP's internal design and development teams
56
-
- Partner organizations collaborating on WRAP initiatives
57
-
- External suppliers and agencies contributing to WRAP projects
58
-
- Anyone building digital experiences within the WRAP ecosystem
59
-
60
-
## How to get started
61
-
62
-
Evergreen provides tools for both designers and developers:
63
-
64
-
-**Figma Resources:** Design with our component library, design tokens, and templates to create experiences that align with WRAP's visual identity.
65
-
-**[Storybook Components](https://evergreen.wrap.ngo/):** Build interfaces efficiently with our coded components, complete with documentation, usage guidelines, and examples.
66
-
-**[Brand Guidelines](https://brand.wrap.ngo):** Access WRAP's complete brand guidelines on Frontify, including logos, tone of voice, photography direction, and printed media.
67
-
68
-
By using these resources, you can create experiences that feel cohesive and authentic to the WRAP brand while saving time on your projects.
82
+
See the [example directory (`./example`)](https://github.com/wrap-org/evergreen/tree/main/example) for a working code example using Vite or head over to the [page setup guide](https://evergreen.wrap.ngo/?path=/docs/guides-page-setup--docs) for information on setting up your first page.
0 commit comments