From 21edf6a6cda9bab992814e4a297c43e98cf70c6d Mon Sep 17 00:00:00 2001 From: Martyna <60158888+martynaaj@users.noreply.github.com> Date: Fri, 24 Jan 2020 21:26:19 +0100 Subject: [PATCH] Update README.md --- README.md | 32 ++++++++++++++++---------------- 1 file changed, 16 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 1783ce21..5d08cf12 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Tabler -Premium and Open Source dashboard template with responsive and high-quality UI. +A premium and open source dashboard template with a responsive and high-quality UI. 👉 [Become a sponsor to Tabler](https://github.com/sponsors/codecalm) 🚀 @@ -20,37 +20,37 @@ Premium and Open Source dashboard template with responsive and high-quality UI. ## Features -We created this admin panel for everyone who wants to create any templates based on our pre-made components. Our mission is to deliver a user-friendly, clear and easy administration panel, that can be used by both, simple websites and sophisticated systems. The only requirement is a basic HTML and CSS (and some [Liquid](https://github.com/Shopify/liquid/wiki)) knowledge—as a reward, you'll be able to manage and visualize different types of data in the easiest possible way! +We've created this admin panel for everyone who wants to create templates based on our pre-made components. Our mission is to deliver a user-friendly, clear and easy administration panel that can be used by both simple websites and sophisticated systems. The only requirement is basic HTML and CSS (and some [Liquid](https://github.com/Shopify/liquid/wiki)) knowledge — as a reward, you'll be able to manage and visualise different types of data in the easiest possible way! -* **Responsive:** With support for mobile, tablet and desktop it doesn’t matter what device you’re using. Tabler is responsive in all major browsers. -* **Cross Browser:** Our theme works perfectly with Latest Chrome, Firefox+, Latest Safari, Opera, Edge and mobile browsers. We work hard to continuously support them. -* **HTML5 & CSS3:** We only use modern web technologies like HTML5 and CSS3. Our theme includes some subtle CSS3 animations so you will get anyone’s attention. -* **Clean Code:** We strictly followed Bootstrap’s guidelines to make your integration as easy as possible. All code is handwritten and W3C valid. -* **Demo pages**: Tabler features over 20 individual pages featuring various components, giving you the freedom to choose and combine. All components can take variation in color and styling that can easily be modified using Sass. The sky is the limit! +* **Responsive:** With the support for mobile, tablet and desktop displays, it doesn’t matter what device you’re using. Tabler is responsive in all major browsers. +* **Cross Browser:** Our theme works perfectly with the latest Chrome, Firefox+, latest Safari, Opera, Edge and mobile browsers. We work hard to to provide continuous support for them. +* **HTML5 & CSS3:** We use only modern web technologies, such as HTML5 and CSS3. Our theme includes some subtle CSS3 animations, which will help you attract attention. +* **Clean Code:** We followed Bootstrap’s guidelines carefully to make your integration as easy as possible. All code is handwritten and W3C valid. +* **Demo pages**: Tabler features over 20 individual pages using various components, which gives you the freedom to choose and combine. All components can vary in color and styling that you can easily modify using Sass. Sky is the limit! * **Single Page Application versions:** [Tabler React](https://github.com/tabler/tabler-react) has React components for Tabler. ## Setup environment -To use our build system and run our documentation locally, you'll need a copy of Tabler's source files. Follow these steps: +To use our build system and run our documentation locally, you'll need a copy of Tabler's source files. Follow the steps below: 1. [Install Node.js](https://nodejs.org/download/), which we use to manage our dependencies. 2. Navigate to the root `/tabler` directory and run `npm install` to install our local dependencies listed in `package.json`. -3. [Install Ruby](https://ruby-lang.org/en/documentation/installation/), recommended version is [2.5.5](https://cache.ruby-lang.org/pub/ruby/2.5/ruby-2.5.5.tar.gz). -4. [Install Bundler](https://bundler.io) with `gem install bundler`, and finally run `bundle install`. This will install all Ruby dependencies, such as [Jekyll and plugins](https://jekyllrb.com). +3. [Install Ruby](https://ruby-lang.org/en/documentation/installation/) - the recommended version is [2.5.5](https://cache.ruby-lang.org/pub/ruby/2.5/ruby-2.5.5.tar.gz). +4. [Install Bundler](https://bundler.io) with `gem install bundler` and finally run `bundle install`. It will install all Ruby dependencies, such as [Jekyll and plugins](https://jekyllrb.com). **Windows users**: -1. [Install Git](https://git-scm.com/download/win) in `C:\Program Files\git\bin` directory and run `npm config set script-shell "C:\\Program Files\git\bin\bash.exe"` to change default shell. -2. [Install Ruby+Devkit](https://rubyinstaller.org/downloads/), recommended version is [2.5.5](https://github.com/oneclick/rubyinstaller2/releases/download/RubyInstaller-2.5.5-1/rubyinstaller-devkit-2.5.5-1-x86.exe). +1. [Install Git](https://git-scm.com/download/win) in `C:\Program Files\git\bin` directory and run `npm config set script-shell "C:\\Program Files\git\bin\bash.exe"` to change the default shell. +2. [Install Ruby+Devkit](https://rubyinstaller.org/downloads/) - the recommended version is [2.5.5](https://github.com/oneclick/rubyinstaller2/releases/download/RubyInstaller-2.5.5-1/rubyinstaller-devkit-2.5.5-1-x86.exe). 3. [Read guide](https://jekyllrb.com/docs/installation/windows/) to get Jekyll up and running without problems. -When completed, you'll be able to run the various commands provided from the command line. +Once you complete the setup, you'll be able to run the various commands provided from the command line. ## Build locally 1. From the root `/tabler` directory, run `npm run start` in the command line. 2. Open [http://localhost:3000](http://localhost:3000) in your browser, and voilà. -3. Any change in `/pages` directory will build application and refresh the page. +3. Any change in the `/pages` directory will build the application and refresh the page. **Note**: Run `npm run build` for reforms a one off build application without refresh. @@ -62,7 +62,7 @@ https://tabler.canny.io/feature-requests ## Bugs and feature requests -Have a bug or a feature request? [Please open a new issue](https://github.com/tabler/tabler/issues/new). +Found a bug or have a feature request? [Please open a new issue](https://github.com/tabler/tabler/issues/new). ## Creators @@ -86,7 +86,7 @@ Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com ## Sponsors -Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/tabler#sponsor)] +Support this project by becoming a sponsor. Your logo will be displayed here with a link to your website. [[Become a sponsor](https://opencollective.com/tabler#sponsor)] -- GitLab