Skip to content

Commit

Permalink
Merge pull request #139 from codedthinking/docs
Browse files Browse the repository at this point in the history
Update installation instructions: Kezdi.jl is now on General
  • Loading branch information
korenmiklos authored Jul 7, 2024
2 parents 43db569 + b8c1b6c commit 581f04f
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,15 +11,15 @@ It imports and reexports [CSV](https://csv.juliadata.org/stable/), [DataFrames](

## Getting started

> `Kezdi.jl` is currently in beta. We have close to 300 unit tests and a large code coverage. [![Coverage](https://codecov.io/gh/codedthinking/Kezdi.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/codedthinking/Kezdi.jl) The package, however, is not guaranteed to be bug-free. If you encounter any issues, please report them as a [GitHub issue](https://github.com/codedthinking/Kezdi.jl/issues/new).
> `Kezdi.jl` is currently in beta. We have more than 300 unit tests and a large code coverage. [![Coverage](https://codecov.io/gh/codedthinking/Kezdi.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/codedthinking/Kezdi.jl) The package, however, is not guaranteed to be bug-free. If you encounter any issues, please report them as a [GitHub issue](https://github.com/codedthinking/Kezdi.jl/issues/new).
>
> If you would like to receive updates on the package, please star the repository on GitHub and sign up for [email notifications here](https://relentless-producer-1210.ck.page/62d7ebb237).
### Installation
To install the package, run the following command in Julia's REPL:

```julia
using Pkg; Pkg.add(url="https://github.com/codedthinking/Kezdi.jl")
using Pkg; Pkg.add("Kezdi")
```

Every Kezdi.jl command is a macro that begins with `@`. These commands operate on a global `DataFrame` that is set using the `setdf` function. Alternatively, commands can be executed within a `@with` block that sets the `DataFrame` for the duration of the block.
Expand Down
4 changes: 2 additions & 2 deletions docs/src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ It imports and reexports [CSV](https://csv.juliadata.org/stable/), [DataFrames](

## Getting started
!!! warning "Kezdi.jl is in beta"
`Kezdi.jl` is currently in beta. We have close to 300 unit tests and a large code coverage. [![Coverage](https://codecov.io/gh/codedthinking/Kezdi.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/codedthinking/Kezdi.jl) The package, however, is not guaranteed to be bug-free. If you encounter any issues, please report them as a [GitHub issue](https://github.com/codedthinking/Kezdi.jl/issues/new).
`Kezdi.jl` is currently in beta. We have more than 300 unit tests and a large code coverage. [![Coverage](https://codecov.io/gh/codedthinking/Kezdi.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/codedthinking/Kezdi.jl) The package, however, is not guaranteed to be bug-free. If you encounter any issues, please report them as a [GitHub issue](https://github.com/codedthinking/Kezdi.jl/issues/new).

If you would like to receive updates on the package, please star the repository on GitHub and sign up for [email notifications here](https://relentless-producer-1210.ck.page/62d7ebb237).

Expand All @@ -18,7 +18,7 @@ It imports and reexports [CSV](https://csv.juliadata.org/stable/), [DataFrames](
To install the package, run the following command in Julia's REPL:

```julia
using Pkg; Pkg.add(url="https://github.com/codedthinking/Kezdi.jl")
using Pkg; Pkg.add("Kezdi")
```

Every Kezdi.jl command is a macro that begins with `@`. These commands operate on a global `DataFrame` that is set using the `setdf` function. Alternatively, commands can be executed within a `@with` block that sets the `DataFrame` for the duration of the block.
Expand Down

0 comments on commit 581f04f

Please sign in to comment.