Skip to content

Commit 9cfe89b

Browse files
authored
Merge pull request #2 from shahryarjb/master
Update README to submit to hex
2 parents fe145df + c5c3d37 commit 9cfe89b

File tree

1 file changed

+10
-8
lines changed

1 file changed

+10
-8
lines changed

README.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,23 @@
1-
# MishkaDeveloperTools
1+
# Mishka Elixir Developer Tools
22

3-
**TODO: Add description**
3+
Recently I have been working on [MishkaCms](https://github.com/mishka-group/mishka-cms), an open-source and free **CMS** for **Elixir** and **Phoenix**. It is very easy to use and has many APIs on both API, and HTML render. In this CMS, I should create some custom macros and modules which are helpful for Elixir developers epically Phoenix **LiveView** fans. Then I test them, and if they are usable, I put them into this project as separated tools.
4+
So when you want to start a project with Elixir, Mishka Developer Tools is an excellent opportunity to finish or start your project as well as possible.
5+
6+
> it should be noted that if you want to test Mishka Developer Tools, please migrate its migrations file; otherwise, you don't need to configure it. The priority is your project database or ORM.
47
58
## Installation
69

7-
If [available in Hex](https://hex.pm/docs/publish), the package can be installed
8-
by adding `mishka_developer_tools` to your list of dependencies in `mix.exs`:
10+
The package can be installed by adding `mishka_developer_tools` to your list of dependencies in `mix.exs`:
911

1012
```elixir
1113
def deps do
1214
[
13-
{:mishka_developer_tools, "~> 0.1.0"}
15+
{:mishka_developer_tools, "~> 0.0.1"}
1416
]
1517
end
1618
```
1719

18-
Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc)
19-
and published on [HexDocs](https://hexdocs.pm). Once published, the docs can
20-
be found at [https://hexdocs.pm/mishka_developer_tools](https://hexdocs.pm/mishka_developer_tools).
20+
The docs can be found at [https://hexdocs.pm/mishka_developer_tools](https://hexdocs.pm/mishka_developer_tools).
2121

22+
---
23+
---

0 commit comments

Comments
 (0)