webskel/cli
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update docs

Browse source
This commit is contained in:
0x1eef 2024-09-22 15:50:11 -03:00
parent a77bf876ee
commit b4f06e325c
1 changed files with 21 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

28
README.md
View file

@ -1,25 +1,35 @@
## About
The webskel utility provides skeletons (or "templates") that can give
you a head start with your next web application or service. The concept
is inspired by skeleton directories from the UNIX world - where they can
be the basis for a new user's `${HOME}` directory.
The `webskel` utility provides skeletons (or "templates") to help you quickly
start your next web application or service. The concept is inspired by skeleton
directories in the UNIX world, where they form the basis for creating a new
user's `${HOME}` directory.
## Examples
**webskel new**
### CLI
The following example demonstrates how the "new" command can create a
"myapp" directory from the skeleton `@webskel/ruby-graphql-webpack-react`:
#### webskel new
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:
user@localhost$ webskel new @webskel/ruby-graphql-webpack-react myapp
**webskel ls**
#### webskel ls
The "ls" command provides a list of available skeletons:
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
[BSD Zero Clause](https://choosealicense.com/licenses/0bsd/) <br>