Update getting started info (Fixes #634) (#635)

This commit is contained in:
Alex Gibson 2020-08-28 15:32:04 +01:00 коммит произвёл GitHub
Родитель bbed6d8fcb
Коммит f36ca8c86c
Не найден ключ, соответствующий данной подписи
Идентификатор ключа GPG: 4AEE18F83AFDEB23
2 изменённых файлов: 8 добавлений и 4 удалений

Просмотреть файл

@ -1,10 +1,12 @@
# Protocol
A modular design system for Mozilla websites.
Protocol is a design system for Mozilla and Firefox websites. It establishes a common design language, provides reusable coded components, and outlines high level guidelines for content and accessibility.
https://protocol.mozilla.org/
Protocol is in an *early stage of development* and likely to change a lot in the near future. If you're interested in using it on your project, let us know and we can help you.
Protocol is still an evolving project. It is used primarily by the Mozilla Websites Marketing team, as the front-end for [https://www.mozilla.org](https://www.mozilla.org). The long term aim is a design system that can be used by anyone at Mozilla to build an on-brand website.
If you're interested in using Protocol in your project, let us know and we can help you. You can find us in #protocol-design-system on Mozillas Slack (for Mozillians) or [file an issue on GitHub](https://github.com/mozilla/protocol/issues).</p>
![Current npm package version.](https://img.shields.io/npm/v/@mozilla-protocol/core)
![Total downloads on npm.](https://img.shields.io/npm/dt/@mozilla-protocol/core)

Просмотреть файл

@ -7,8 +7,6 @@ order: 0
<div class="mzp-c-article">
<div class="mzp-c-article-intro">
<p>Protocol is a design system for Mozilla and Firefox websites. It establishes a common design language, provides reusable coded components, and outlines high level guidelines for content and accessibility.</p>
<p>Protocol is still in an <strong>early stage of development</strong> and likely to change a lot in the near future. If youre interested in using Protocol on your project, let us know and we can help you. You can find us in #design-systems on Mozillas Slack (for Mozillians) or <a href="https://github.com/mozilla/protocol/issues">file an issue on GitHub</a>.</p>
</div>
<p>When design systems are effectively employed, the benefits are manifold:</p>
@ -19,5 +17,9 @@ order: 0
<li>Clarity: With clearly documented guidelines and governance for design and content creation, we spend less time negotiating the guidelines to create clarity for ourselves and more time creating designs and content that clearly serves our users.</li>
</ul>
<p>Protocol is still an evolving project. It is used primarily by the Mozilla Websites Marketing team, as the front-end for <a href="https://www.mozilla.org">https://www.mozilla.org</a>. The long term aim is a design system that can be used by anyone at Mozilla to build an on-brand website.</p>
<p>If you're interested in using Protocol in your project, let us know and we can help you. You can find us in #protocol-design-system on Mozillas Slack (for Mozillians) or <a href="https://github.com/mozilla/protocol/issues">file an issue on GitHub</a>.</p>
<p><a href="https://github.com/mozilla/protocol">Follow along on GitHub</a>.</p>
</div>