Skip to content

Commit

Permalink
docs: merge docs/README to README
Browse files Browse the repository at this point in the history
  • Loading branch information
jhaemin committed Feb 10, 2020
1 parent 60cf8f3 commit c461ee2
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 29 deletions.
36 changes: 29 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
![banner](https://user-images.githubusercontent.com/19797697/73181225-d21c1b80-40e4-11ea-80b1-d84fa6bb3a0a.png)

<p align="center"><b>eodiro</b> is an open source utility service for Chung-Ang university students.</p>
<p align="center">
<a href="https://eodiro.com">https://eodiro.com</a>
</p>

<p align="center">
<img src="https://img.shields.io/github/license/paywteam/eodiro" />
Expand All @@ -13,11 +16,30 @@

---

## How to Use
## Documentation

### Wiki

- [Terms](https://github.com/paywteam/eodiro/blob/master/docs/wiki/Terms.md)
- [Design Guidelines](https://github.com/paywteam/eodiro/blob/master/docs/wiki/Design-Guidelines.md)
- [UI Components](https://github.com/paywteam/eodiro/blob/master/docs/wiki/UI-Components.md)
- [CustomEvents](https://github.com/paywteam/eodiro/blob/master/docs/wiki/CustomEvents.md)
- [Modules](https://github.com/paywteam/eodiro/blob/master/docs/wiki/Modules.md)
- [Plugins](https://github.com/paywteam/eodiro/blob/master/docs/wiki/Plugins.md)
- Middleware
- [Vuex Store](https://github.com/paywteam/eodiro/blob/master/docs/wiki/Vuex-Store.md)
- [Vue Mixins](https://github.com/paywteam/eodiro/blob/master/docs/wiki/Vue-Mixins.md)

**Components**

- [Banner](https://github.com/paywteam/eodiro/blob/master/docs/wiki/Banner.md)
- [Tiles](https://github.com/paywteam/eodiro/blob/master/docs/wiki/Tiles.md)

---

https://eodiro.com
**[Changelog](https://github.com/paywteam/eodiro/blob/master/docs/Changelog.md)**

## [Documentation](https://github.com/paywteam/eodiro/tree/master/docs)
**[ToDo](https://github.com/paywteam/eodiro/blob/master/docs/ToDo.md)**

## Build Instructions

Expand All @@ -28,20 +50,20 @@ https://eodiro.com
3. Go to the project's root directory and install dependencies.

```zsh
npm install
% npm install
```

4. Happy developing

```zsh
# Development
npm run dev
% npm run dev
```

```zsh
# Build and start the server
npm run build
npm run start
% npm run build
% npm run start
```

## Contributing
Expand Down
22 changes: 0 additions & 22 deletions docs/README.md

This file was deleted.

0 comments on commit c461ee2

Please sign in to comment.