From 428af5e1b236616bcafcbcc27374ae54b37b5a95 Mon Sep 17 00:00:00 2001 From: Jason Falk Date: Wed, 26 Dec 2018 17:14:31 -0800 Subject: [PATCH] Updated content for README.MD (#1224) * Updated content for README.MD Updated/edited content and added logo. More changes coming soon but this fixes some larger issues with messaging. * Update README.md * Update issue templates (#1225) * Update issue templates I have simplified the templates and made them more consistent. Also deleted a placeholder template we were not using. * Update report-a-bug.md * Delete Bug_report.md * Delete Feature_request.md * Update README.md * fix: updated component readme.md files to be more consistent (#1232) * fix: updated description * fix: updated consistency across readme files as a first pass * removed package.json which should not be part of this commit * package.json * reset package.json * Update README.md * added display names for components in fast layouts (#1221) * chore: style changes for documentation web sites, fixed focus, responsive, loc, and other touches; update does not address content (#1233) * fix: updated description * removed package.json which should not be part of this commit * package.json * reset package.json * additional updates to style and structure on documentation site * Style updates for documentation web sites, also fixed focus, responsive, loc, and other touches; update does not address content * added display names for components in fast layouts (#1221) * fix: updated description * removed package.json which should not be part of this commit * package.json * reset package.json * additional updates to style and structure on documentation site * Style updates for documentation web sites, also fixed focus, responsive, loc, and other touches; update does not address content * class to className change and extra comments in css * fix: updated description (#1231) * chore: update the pull request template and documentation (#1230) * chore: update the pull request template and documentation * chore: update the pull request template and documentation * Updates based on pr comments * move file to appropriate directory * Updated content for README.MD Updated/edited content and added logo. More changes coming soon but this fixes some larger issues with messaging. * Update README.md * Update README.md * Update README.md * Updated lerna link per PR request * Updated content for README.MD Updated/edited content and added logo. More changes coming soon but this fixes some larger issues with messaging. * Update README.md * Update README.md * Update README.md * Updated content for README.MD Updated/edited content and added logo. More changes coming soon but this fixes some larger issues with messaging. * Update README.md * Update README.md * formatting changes in .MD and update of Lerna URL * Updated lerna link per PR request * updated md formatting and lerna link --- README.md | 55 ++++++++++++++++++++++++++++++++++++++++--------------- 1 file changed, 40 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index e3a0472ce97..a806e01a2fb 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,10 @@ -# FAST-DNA overview -FAST-DNA is a set of tooling, resources, and components used to accelerate building Web sites and applications. +![github_readme_logo.svg](https://images.zenhubusercontent.com/5a85d50c4b5806bc2bc7186b/408ec7e2-a641-4802-a6de-b3b3ada0445d) -Teams spend significant time building parts of the design system (colors, variable font, typography, grid, components, etc.) which can slow adoption of the latest design guidelines and related technologies. FAST-DNA solves this problem by providing tooling and resources to accelerate development with code that is performant and accessible. Many of the resources are written to be framework agnostic and will work with any component library and JavaScript framework (React, Angular, etc.). We also support a number of React-specific packages for UI generation. +# FAST-DNA + +An unopinionated system of components, development tools, and utilities used à la carte or as a suite to build enterprise-grade websites and applications. -## Status [![Maintainability](https://api.codeclimate.com/v1/badges/8a74621e634a6e9b9561/maintainability)](https://codeclimate.com/github/Microsoft/fast-dna/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/8a74621e634a6e9b9561/test_coverage)](https://codeclimate.com/github/Microsoft/fast-dna/test_coverage) [![CircleCI](https://circleci.com/gh/Microsoft/fast-dna/tree/master.svg?style=shield&circle-token=d159a8b24ccb8046e07138c98717c32cb92589d6)](https://circleci.com/gh/Microsoft/fast-dna/tree/master) @@ -13,21 +13,46 @@ Teams spend significant time building parts of the design system (colors, variab [![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier) ![license](https://img.shields.io/github/license/mashape/apistatus.svg) -## Packages -[Lerna](https://github.com/lerna/lerna#independent-mode---independent) is used to organize and manage this mono repository. Most of these packages are published to NPM. Users can choose à la carte which utility service to use in their development efforts. +:star: We appreciate your star, it helps! + +## Key features & benefits + +### Unopinionated + +There are a million and one great ways to build your next website or application. To support the technologies you choose, creating unopinionated code is at the center of every decision we make in FAST-DNA. + +This principle of being unopinionated manifests in several important ways including: + +* A flat component architecture that lets you compose what you need without struggling with rigid patterns and complex objects. +* Separating base components and style that supports multiple frameworks without re-writing or duplicating styles. This separation also lets you build your own styles, with your styling technology of choice, without having to re-build or duplicate the base components. +* Framework agnostic tooling that lets you use our development tools with any view framework. +* The ability to replace almost any FAST-DNA package with your package of choice. Get started with our animation or layout package and add more as you need them. Alternatively, use our suite of packages to build your next project from the ground up; it's your call. + +### UI development and style guide tools -## Browser support -Cross browser testing based on web browser rendering engines. +When developing components and views, excellent development tooling can make all the difference. FAST-DNA offers development and style guide tools that work with FAST components, components from other frameworks, or your components. -![Browser matrix](https://saucelabs.com/browser-matrix/FAST-DNA.svg) +Try out component properties with an auto-generated props UI, get a live preview of the code based on any property’s configuration, preview localization (RTL/LTR) and themes, and preview component compositing with a transparency grid. -[![Build Status](https://saucelabs.com/buildstatus/FAST-DNA)](https://saucelabs.com/beta/builds/33e17283a9fb447ab220a8e00abe8f26) +Also, we built FAST development tools from re-usable packages so, if you have special needs, you can build your tools from the same shared libraries. + +### Bring your design system + +Widely available design systems from companies like Microsoft (Fluent), Google (Material), or Salesforce (Lightning) are useful when it is essential to align with a platform or take advantage of a polished system at low cost, but many companies have their design system of their own, and some may have multiple design systems or variations. + +Because FAST-DNA has abstracted base components from their style, you get a head start on your design system by building on top of tried and true base components and style libraries like our offerings for color, animation, and elevation. + +## Packages + +FAST-DNA is a mono repository managed with [Lerna](https://github.com/lerna/lerna). Users choose à la carte which package to use in their project. ## Documentation -Checkout the [developer documentation](https://microsoft.github.io/fast-dna/docs/readme) for guidance on getting started, contributing, consumption, quality, testing, help, and community policies. + +Check out our [developer documentation](https://microsoft.github.io/fast-dna/docs/readme) to get started. ## Contact -* Join the community [on Discord](https://discord.gg/FcSNfg4) -* Ask for help [on Stack Overflow](https://stackoverflow.com/questions/tagged/fast-dna) -* Submit [requests / issues](https://github.com/Microsoft/fast-dna/issues/new/choose) -* Contributors [find issues to work on](https://github.com/Microsoft/fast-dna/labels/good%20first%20issue) + +* Join the community on [Discord](https://discord.gg/FcSNfg4). +* Ask for help on [Stack Overflow](https://stackoverflow.com/questions/tagged/fast-dna). +* Submit reqests and issues on [Github](https://github.com/Microsoft/fast-dna/issues/new/choose). +* Contributors, find good first issues on [Github](https://github.com/Microsoft/fast-dna/labels/good%20first%20issue).