Skip to content

Commit 69c3152

Browse files
committed
docs(README): update readme
1 parent fbd2c2d commit 69c3152

6 files changed

Lines changed: 170 additions & 18 deletions

File tree

.eslintrc.js

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,11 @@
11
module.exports = {
2+
plugins: [
3+
"security"
4+
],
25
extends: [
36
'eslint:recommended',
4-
'plugin:vue/recommended'
7+
'plugin:vue/recommended',
8+
"plugin:security/recommended",
59
],
610
rules: {
711
"space-before-function-paren": ["error", "always"],

README.md

Lines changed: 101 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,72 @@
1-
# monorail
1+
<div align="center">
2+
<img src="./assets/logo.png" />
3+
<h3>Metro UI compent library for <a href="https://vuejs.org">Vue.js</a></h3>
4+
<br>
5+
<img src="https://img.shields.io/npm/v/@miniarray/monorail.svg" alt="npm" />
6+
<img src="https://img.shields.io/circleci/project/github/miniArray/monorail.svg" alt="CircleCI" />
7+
<img src="https://img.shields.io/github/license/miniArray/monorail.svg" alt="license" />
8+
<img src="https://img.shields.io/github/issues-raw/miniArray/monorail.svg" alt="GitHub issues" />
9+
<a href="https://app.fossa.io/projects/git%2Bgithub.com%2FminiArray%2Fmonorail?ref=badge_shield"><img src="https://app.fossa.io/api/projects/git%2Bgithub.com%2FminiArray%2Fmonorail.svg?type=shield" alt="FOSSA Status" /></a>
10+
<br>
11+
<img src="https://img.shields.io/github/commit-activity/y/miniArray/monorail.svg" alt="GitHub commit activity the past week, 4 weeks, year" />
12+
<img src="https://img.shields.io/github/last-commit/miniArray/monorail.svg" alt="GitHub last commit" />
13+
<a href="https://www.npmjs.com/package/@miniarray/monorail"><img src="https://img.shields.io/npm/dm/@miniarray/monorail.svg" alt="npm" /></a>
14+
<br>
15+
<a href="https://david-dm.org/miniArray/monorail?type=dev"><img src="https://david-dm.org/miniArray/monorail/dev-status.svg" alt="devDependenciesStatus" /></a>
16+
<a href="https://david-dm.org/miniArray/monorail?type=peer"><img src="https://david-dm.org/miniArray/monorail/peer-status.svg" alt="peerDependenciesStatus" /></a>
17+
<a href="https://nodesecurity.io/orgs/miniarray/projects/12ea7e2d-3c86-4196-b4ad-bb8abc355d19"><img src="https://nodesecurity.io/orgs/miniarray/projects/12ea7e2d-3c86-4196-b4ad-bb8abc355d19/badge" alt="NSP Status" /></a>
18+
<br>
19+
<a href="https://greenkeeper.io/"><img src="https://badges.greenkeeper.io/miniArray/monorail.svg" alt="Greenkeeper badge" /></a>
20+
<a href="https://github.com/miniArray/monorail/issues"><img src="https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat" alt="contributions welcome" /></a>
21+
<a href="https://www.codetriage.com/miniarray/monorail"><img src="https://www.codetriage.com/miniarray/monorail/badges/users.svg" alt="Open Source Helpers" /></a>
22+
<br>
23+
<img src="https://img.shields.io/codecov/c/github/miniArray/monorail.svg" alt="Codecov" />
24+
<a href="https://codebeat.co/projects/github-com-miniarray-monorail-master"><img src="https://codebeat.co/badges/83a1a3eb-c751-4782-b994-e2a16428a1b1" alt="codebeat badge" /></a>
25+
<a href="https://chat.monorail.rocks">
26+
<img src="https://img.shields.io/badge/chat-on%20discord-7289da.svg" alt="Chat">
27+
</a>
28+
<a href="./docs/donate.md">
29+
<img src="https://img.shields.io/badge/$-donate-ff69b4.svg?maxAge=2592000&style=flat" alt="Chat">
30+
</a>
31+
</div>
232

3-
![npm](https://img.shields.io/npm/v/@miniarray/monorail.svg)
4-
![CircleCI](https://img.shields.io/circleci/project/github/miniArray/monorail.svg)
33+
# Introduction
534

6-
[![codebeat badge](https://codebeat.co/badges/83a1a3eb-c751-4782-b994-e2a16428a1b1)](https://codebeat.co/projects/github-com-miniarray-monorail-master)
7-
![license](https://img.shields.io/github/license/miniArray/monorail.svg)
8-
![Codecov](https://img.shields.io/codecov/c/github/miniArray/monorail.svg)
35+
monorail is a metro UI component framework for [Vue.js](https://vuejs.com). It aims to provide clean, semantic and reusable components that make building your web based windows application a breeze.
936

10-
![GitHub issues](https://img.shields.io/github/issues-raw/miniArray/monorail.svg)
11-
![GitHub commit activity the past week, 4 weeks, year](https://img.shields.io/github/commit-activity/y/miniArray/monorail.svg)
12-
![GitHub last commit](https://img.shields.io/github/last-commit/miniArray/monorail.svg)
37+
## Browser Support
1338

39+
monorail supports **[evergreen browsers](https://www.techopedia.com/definition/31094/evergreen-browser)**, mobile, laptop & desktop.
40+
41+
# Documentation
42+
43+
You can find the monorail documentation [on the website](https://monorail.rocks).
44+
45+
## One minute Quick-start
46+
47+
[Codepen link](http://starter.monorail.rocks)
48+
```html
49+
<!DOCTYPE html>
50+
<html>
51+
<head>
52+
<link href="https://unpkg.com/metro4@4/build/css/metro-all.css" rel="stylesheet" />
53+
<meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1, user-scalable=no, minimal-ui">
54+
</head>
55+
<body>
56+
<div id="app">
57+
<m-switch :checked="true" />
58+
</div>
59+
60+
<script src="https://unpkg.com/vue@2/dist/vue.js"></script>
61+
<script src="https://unpkg.com/@miniarray/monorail/dist/components/monorail.js"></script>
62+
<script>
63+
new Vue({
64+
el: '#app'
65+
})
66+
</script>
67+
</body>
68+
</html>
69+
```
1470
# Installation
1571

1672
## Modern
@@ -34,4 +90,39 @@ Vue.use(Monorail)
3490
<link href="https://unpkg.com/metro4@4/build/css/metro-all.css" rel="stylesheet" />
3591
<script src="https://unpkg.com/vue@2/dist/vue.js"></script>
3692
<script src="https://unpkg.com/@miniarray/monorail/dist/components/monorail.js"></script>
37-
```
93+
```
94+
95+
# Running The Test Suite
96+
97+
**Console:**
98+
99+
Installed the dependencies, via:
100+
101+
npm install
102+
103+
then you can run the tests (and get detailed output) by running:
104+
105+
npm test
106+
107+
# Community Support
108+
109+
Ask your support questions on the [monorail Discord Community](https://chat.monorail.rocks).
110+
111+
## Contributing
112+
113+
Developers interested in contributing should read the [Code of Conduct](./docs/code_of_conduct.md).
114+
115+
> Please do **not** ask general questions in an issue. Issues are only to report bugs, request
116+
enhancements, or request new features. For general questions and discussions, ask on the [monorail Discord Community](http://chat.monorail.rocks).
117+
118+
It is important to note that for each release, the detailed changes are documented in the [release notes](http://releases.monorail.rocks).
119+
120+
### Contributing Guide
121+
122+
You can report issues by following the [Issue Template](http://issues.monorail.rocks) and you can create a minimal reproduction with a [CodePen template](http://template.monorail.rocks) or a full project at [CodeSandbox](https://codesandbox.io/s/vue).
123+
124+
We also have a list of [help wanted](http://help.monorail.rocks) issues that you might want to check.
125+
126+
# License
127+
128+
monorail is [MIT licensed](./LICENSE).

assets/logo.png

8.55 KB
Loading

docs/code_of_conduct.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
6+
7+
## Our Standards
8+
9+
Examples of behavior that contributes to creating a positive environment include:
10+
11+
* Using welcoming and inclusive language
12+
* Being respectful of differing viewpoints and experiences
13+
* Gracefully accepting constructive criticism
14+
* Focusing on what is best for the community
15+
* Showing empathy towards other community members
16+
17+
Examples of unacceptable behavior by participants include:
18+
19+
* The use of sexualized language or imagery and unwelcome sexual attention or advances
20+
* Trolling, insulting/derogatory comments, and personal or political attacks
21+
* Public or private harassment
22+
* Publishing others' private information, such as a physical or electronic address, without explicit permission
23+
* Other conduct which could reasonably be considered inappropriate in a professional setting
24+
25+
## Our Responsibilities
26+
27+
Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
28+
29+
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
30+
31+
## Scope
32+
33+
This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
34+
35+
## Enforcement
36+
37+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
38+
39+
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
40+
41+
## Attribution
42+
43+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
44+
45+
[homepage]: http://contributor-covenant.org
46+
[version]: http://contributor-covenant.org/version/1/4/

package-lock.json

Lines changed: 14 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,7 @@
1818
"engines": {
1919
"node": ">=9"
2020
},
21-
"dependencies": {
22-
},
21+
"dependencies": {},
2322
"scripts": {
2423
"serve": "run-p serve:*",
2524
"serve:styleguide": "vue-styleguidist server",
@@ -41,20 +40,21 @@
4140
"devDependencies": {
4241
"babel-jest": "^21.0.2",
4342
"babel-plugin-transform-object-rest-spread": "^6.26.0",
44-
"ramda": "^0.25.0",
45-
"ramda-adjunct": "^2.5.0",
4643
"commitizen": "^2.9.6",
4744
"cross-env": "^5.1.4",
4845
"css-loader": "^0.28.7",
4946
"cz-conventional-changelog": "^2.1.0",
5047
"eslint": "^4.18.2",
48+
"eslint-plugin-security": "^1.4.0",
5149
"eslint-plugin-vue": "^4.3.0",
5250
"husky": "^0.15.0-rc.9",
5351
"jest": "^22.0.4",
5452
"jest-serializer-vue": "^0.3.0",
5553
"mkdirp": "^0.5.1",
5654
"npm-run-all": "^4.1.2",
5755
"push-dir": "^0.4.1",
56+
"ramda": "^0.25.0",
57+
"ramda-adjunct": "^2.5.0",
5858
"sass-loader": "^6.0.6",
5959
"semantic-release": "^15.0.3",
6060
"style-loader": "^0.19.0",

0 commit comments

Comments
 (0)