Update docs
This commit is contained in:
parent
a77bf876ee
commit
b4f06e325c
1 changed files with 21 additions and 11 deletions
32
README.md
32
README.md
|
@ -1,24 +1,34 @@
|
||||||
## About
|
## About
|
||||||
|
|
||||||
The webskel utility provides skeletons (or "templates") that can give
|
The `webskel` utility provides skeletons (or "templates") to help you quickly
|
||||||
you a head start with your next web application or service. The concept
|
start your next web application or service. The concept is inspired by skeleton
|
||||||
is inspired by skeleton directories from the UNIX world - where they can
|
directories in the UNIX world, where they form the basis for creating a new
|
||||||
be the basis for a new user's `${HOME}` directory.
|
user's `${HOME}` directory.
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
**webskel new**
|
### CLI
|
||||||
|
|
||||||
The following example demonstrates how the "new" command can create a
|
#### webskel new
|
||||||
"myapp" directory from the skeleton `@webskel/ruby-graphql-webpack-react`:
|
|
||||||
|
|
||||||
user@localhost$ webskel new @webskel/ruby-graphql-webpack-react myapp
|
The `webskel new` command creates a new application from a specified skeleton.
|
||||||
|
For example, the following command will create a "myapp" directory using the
|
||||||
|
`@webskel/ruby-graphql-webpack-react` skeleton:
|
||||||
|
|
||||||
**webskel ls**
|
user@localhost$ webskel new @webskel/ruby-graphql-webpack-react myapp
|
||||||
|
|
||||||
The "ls" command provides a list of available skeletons:
|
#### webskel ls
|
||||||
|
|
||||||
user@localhost webskel ls
|
The `webskel ls` command lists all available skeletons. These skeletons are
|
||||||
|
located in the [share/webskel/](share/webskel) directory, which is typically
|
||||||
|
installed relative to `/usr/local`:
|
||||||
|
|
||||||
|
user@localhost webskel ls
|
||||||
|
|
||||||
|
## Sources
|
||||||
|
|
||||||
|
* [GitHub](https://github.com/webskel/cli#readme)
|
||||||
|
* [GitLab](https://gitlab.com/webskel/cli#readme)
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue