From 70d40ab0c7dfcfb95d8c0ef1c2e940b3f1aaaa54 Mon Sep 17 00:00:00 2001 From: zhengchun Date: Fri, 3 Nov 2023 16:14:54 +0800 Subject: [PATCH] README --- README.md | 46 +++++++--------------------------------------- 1 file changed, 7 insertions(+), 39 deletions(-) diff --git a/README.md b/README.md index 32aa32a8..6f6d7db1 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,14 @@ -Atlassian Design for Bootstrap v5 +Awesome Bootstrap Theme Designed with Atlassian Design === -The most popular Bootstrap UI Kits with Atlassian Design for your next project quickly get you started. +A Beautiful Free Bootstrap theme with fully responsive, powerful CSS utilities, expertly crafted components with Atlassian Design. [![npm version](https://img.shields.io/npm/v/fastbootstrap)](https://www.npmjs.com/package/fastbootstrap) [![MIT license](https://img.shields.io/github/license/fastbootstrap/atlassian-design-for-bootstrap)](https://github.com/fastbootstrap/atlassian-design-for-bootstrap/blob/master/LICENSE) +[![](https://data.jsdelivr.com/v1/package/npm/fastbootstrap/badge)](https://www.jsdelivr.com/package/npm/fastbootstrap) ## Quick start -### Install +### Install with NPM This repository is distributed with npm. @@ -23,51 +24,18 @@ After installion, you can building SCSS and JS using this snippet. npm run dist ``` -### CDN +### from CDN + +Use a CDN for load compiled JS and CSS from jsdelivr. https://www.jsdelivr.com/package/npm/fastbootstrap ## Documentation -The documentation included in this repo in the root directory, and is built with [Hugo](https://gohugo.io/). - Browse the online documentation, visit [fastbootstrap.com](https://fastbootstrap.com). -Documentation search is powered by open source [Lunr](https://lunrjs.com/). - -### Running documentation locally - -```sh -hugo server --port 9001 -``` - -Open `http://localhost:9001/` in your browser now. - ## Community For help, or a feature request: [Discuss on GitHub](https://github.com/fastbootstrap/atlassian-design-for-bootstrap/discussions) - - -## Extended Components - -The extended components below are ready to your project, it's free forever. - -- [Avatar](https://fastbootstrap.com/components/avatar/) -- [Avatar Group](https://fastbootstrap.com/components/avatar-group/) -- [Blankslate](https://fastbootstrap.com/components/blankslate/) -- [Layout](https://fastbootstrap.com/components/layout/) -- [Lozenge](https://fastbootstrap.com/components/lozenge/) -- [Menu](https://fastbootstrap.com/components/menu/) -- [Progress Indicator](https://fastbootstrap.com/components/progress-indicator/) -- [Progress Tracker](https://fastbootstrap.com/components/progress-tracker/) -- [Rating](https://fastbootstrap.com/components/rating/) -- [Side Navigation](https://fastbootstrap.com/components/side-navigation/) -- [Tag](https://fastbootstrap.com/components/tag/) - -Browse [all components](https://fastbootstrap.com/components) - -## Contributing - -Feel free to raise an issue or submit a pull request.