Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
dustessavdh committed Aug 20, 2024
1 parent b4323ad commit 041778c
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 17 deletions.
21 changes: 8 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,16 @@
# KinoLibgraph

**TODO: Add description**
[![Docs](https://img.shields.io/badge/hex.pm-docs-8e7ce6.svg)](https://hexdocs.pm/kino_libgraph)
[![build](https://github.com/hergetto/kino_libgraph/actions/workflows/branch-workflow.yml/badge.svg)](https://github.com/hergetto/kino_libgraph/actions/workflows/branch-workflow.yml)

[Libgraph](https://github.com/bitwalker/libgraph) integration with [Kino](https://github.com/livebook-dev/kino) for [Livebook](https://github.com/livebook-dev/livebook).

## Installation

If [available in Hex](https://hex.pm/docs/publish), the package can be installed
by adding `kino_libgraph` to your list of dependencies in `mix.exs`:
To use KinoLibgraph with Livebook, you only have to run `Mix.install/2`:

```elixir
def deps do
[
{:kino_libgraph, "~> 0.1.0"}
]
end
Mix.install([
{:kino_libgraph, "~> 0.1.0"}
])
```

Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc)
and published on [HexDocs](https://hexdocs.pm). Once published, the docs can
be found at <https://hexdocs.pm/kino_libgraph>.

2 changes: 0 additions & 2 deletions assets/vis-network/src/main.js
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
import vis from "vis-network";

export function init(ctx, content) {
console.log(content);

const { nodes, edges, type } = content;

const container = ctx.root;
Expand Down
2 changes: 0 additions & 2 deletions lib/kino_libgraph/application.ex
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@ defmodule KinoLibgraph.Application do
use Application

def start(_type, _args) do
# TODO create SmartCell

children = []
opts = [strategy: :one_for_one, name: KinoLibgraph.Supervisor]
Supervisor.start_link(children, opts)
Expand Down

0 comments on commit 041778c

Please sign in to comment.