Skip to content

edit readme #20

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
tansiret wants to merge 1 commit into
base: development
Choose a base branch
from
Open

edit readme #20

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 33 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,9 @@
</a>
</p>

neumorphic.css is a lightweight, responsive and modern CSS framework.
neumorphic.css is a single-file, lightweight, responsive and modern CSS framework.

- Incredibly KISS.
- Lightweight (~1.51kB minzipped), blazing fast.
- Flexbox-based, responsive and mobile-friendly layout
- Elegantly designed and developed elements and components
Expand All @@ -46,7 +47,34 @@ neumorphic.css is a lightweight, responsive and modern CSS framework.
- [Copyright and License](#license)

## <a name="gettingstarted"></a>Getting started
neumorphic.css is available via either NPM (preferred), Yarn, or a CDN.
neumorphic.css is available via either direct installation, NPM, Yarn, or a CDN.


### KISSest Installation

1. Clone the file wherever you want via wget or curl

```shell
wget https://raw.githubusercontent.com/Webments/neumorphic.css/development/neumorphic.min.css
```

or

```shell
curl -o simplistika.css "https://raw.githubusercontent.com/Webments/neumorphic.css/development/neumorphic.min.css"
```

2. Insert the line below to your head area in your HTML file

```html
<!-- index.html (that is just an example)-->
<html>
<head>
<link rel="stylesheet" type="text/css" href="neumorphic-min.css" />
Copy link
Contributor

@ardacebi ardacebi May 22, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

neumorphic-min.css should be neumorphic.min.css

</head>
<body></body>
</html>
```

### NPM

Expand All @@ -58,7 +86,7 @@ npm i webments-neumorphic
2. Insert the line below to your head area in your HTML file

```html
<!-- index.html -->
<!-- index.html (that is just an example)-->
<html>
<head>
<link rel="stylesheet" type="text/css" href="node_modules/webments-neumorphic/dist/css/neumorphic.min.css" />
Expand All @@ -79,7 +107,7 @@ yarn add webments-neumorphic
2. Insert the line below to your head area in your HTML file

```html
<!-- index.html -->
<!-- index.html (that is just an example)-->
<html>
<head>
<link rel="stylesheet" type="text/css" href="node_modules/webments-neumorphic/dist/css/neumorphic.min.css" />
Expand Down Expand Up @@ -110,7 +138,7 @@ e.g. `https://unpkg.com/[email protected]/dist/css/paper.min.css` (versi
2. Import the CDN from your head area in your HTML file

```html
<!-- index.html -->
<!-- index.html (that is just an example)-->
<html>
<head>
<link rel="stylesheet" type="text/css" href="https://unpkg.com/webments-neumorphic/dist/css/neumorphic.min.css" />
Expand Down