-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
52 changed files
with
469 additions
and
458 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,47 @@ | ||
# Merkur - CLI | ||
<p align="center"> | ||
<a href="https://merkur.js.org/docs/getting-started" title="Getting started"> | ||
<img src="https://raw.githubusercontent.com/mjancarik/merkur/master/images/merkur-illustration.png" width="100px" height="100px" alt="Merkur illustration"/> | ||
</a> | ||
</p> | ||
|
||
## About Merkur | ||
# Merkur | ||
|
||
The [Merkur](https://merkur.js.org/) is tiny extensible javascript library for front-end microservices. It allows by default server side rendering for loading performance boost. You can connect it with other frameworks or languages because merkur defines easy API. You can use one of four predefined template's library [Preact](https://preactjs.com/), [µhtml](https://github.com/WebReflection/uhtml#readme), [Svelte](https://svelte.dev/) and [vanilla](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Template_literals) but you can easily extend for others. | ||
[](https://github.com/mjancarik/merkur/actions/workflows/ci.yml) | ||
[](https://www.npmjs.com/package/@merkur/core) | ||
 | ||
[](https://github.com/prettier/prettier) | ||
|
||
The [Merkur](https://merkur.js.org/) is tiny extensible javascript library for front-end microservices(micro frontends). It allows by default server side rendering for loading performance boost. You can connect it with other frameworks or languages because merkur defines easy API. You can use one of six predefined template's library [Preact](https://preactjs.com/), [µhtml](https://github.com/WebReflection/uhtml#readme), [Svelte](https://svelte.dev/) and [vanilla](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Template_literals) but you can easily extend for others. | ||
|
||
## Features | ||
- Flexible templating engine | ||
- Usable with all tech stacks | ||
- SSR-ready by default | ||
- Easy extensible with plugins | ||
- Tiny - 1 KB minified + gzipped | ||
|
||
## Getting started | ||
|
||
```bash | ||
npx @merkur/create-widget <name> | ||
|
||
cd name | ||
|
||
npm run dev // Point your browser at http://localhost:4444/ | ||
``` | ||
 | ||
## Documentation | ||
|
||
To check out [live demo](https://merkur.js.org/demo) and [docs](https://merkur.js.org/docs), visit [https://merkur.js.org](https://merkur.js.org). | ||
|
||
## Contribution | ||
|
||
Contribute to this project via [Pull-Requests](https://github.com/mjancarik/merkur/pulls). | ||
|
||
We are following [Conventional Commits Specification](https://www.conventionalcommits.org/en/v1.0.0/#summary). To simplify the commit process, you can use `npm run commit` command. It opens an interactive interface, which should help you with commit message composition. | ||
|
||
Thank you to all the people who already contributed to Merkur! | ||
|
||
<a href="https://github.com/mjancarik/merkur/graphs/contributors"> | ||
<img src="https://contrib.rocks/image?repo=mjancarik/merkur" /> | ||
</a> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.