Improve readme

This commit is contained in:
Anton Vakhrushev 2019-11-10 22:25:27 +03:00
parent f3f23fc868
commit 076e4ca4fb
3 changed files with 19 additions and 22 deletions

View File

@ -13,7 +13,7 @@ install-shards:
shards install
.PHONY: install
install: build-docker install-shards
install: build-docker install-shards install-assets build-assets
.PHONY: build
build:
@ -24,6 +24,9 @@ build:
format:
crystal tool format ./src ./spec
install-assets:
nodejs npm install
build-assets:
rm -rf ./public/assets
nodejs npm run-script build
@ -39,7 +42,8 @@ run: format
.PHONY: run-server
run-server: format
BASE_PATH="./tmp" server run $(ENTRY_POINT)
mkdir -p ./var/data
BASE_PATH="./var/data" server run $(ENTRY_POINT)
.PHONY: spec
spec: format

View File

@ -1,27 +1,20 @@
# Can I take a daya off?
# Can I take a day off?
TODO: Write a description here
[![CircleCI](https://circleci.com/gh/anwinged/dayoff/tree/master.svg?style=svg)](https://circleci.com/gh/anwinged/dayoff/tree/master)
Simple app for time traking. Pet project created with Crystal, Vue.js and Circle CI.
## Installation
TODO: Write installation instructions here
With docker you can run
## Usage
$ make install
$ make run-server
TODO: Write usage instructions here
Next open <http://localhost:3000/?profile=profile-xyz> in browser,
where `profile-xyz` is profile name stored in `var/data` directory.
## Development
## Tests
TODO: Write development instructions here
## Contributing
1. Fork it (<https://github.com/your-github-user/dayoff/fork>)
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request
## Contributors
- [your-name-here](https://github.com/your-github-user) - creator and maintainer
$ make spec
$ make ameba

View File

@ -36,7 +36,7 @@
"format-js": "prettier --single-quote --trailing-comma es5 --write \"./assets/**/*.js\"",
"format-vue": "prettier --single-quote --trailing-comma es5 --write \"./assets/**/*.vue\"",
"format-style": "prettier --single-quote --write \"assets/**/*.scss\"",
"format-md": "prettier --print-width=80 --parser=markdown --write \"source/**/*.md\""
"format-md": "prettier --print-width=80 --parser=markdown --write \"README.md\""
},
"dependencies": {},
"browserslist": [