Skip to content

Commit 8d2c57d

Browse files
cpflatclaude
andcommitted
add README badges and wiki link
Mirror amulog's badge set (PyPI version/pyversions, BSD-3-Clause, test CI, docs-wiki) and point Usage at the project wiki for full documentation. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
1 parent f5de401 commit 8d2c57d

1 file changed

Lines changed: 24 additions & 1 deletion

File tree

‎README.rst‎

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,27 @@
22
logdag
33
######
44

5+
.. image:: https://img.shields.io/pypi/v/logdag
6+
:alt: PyPI release
7+
:target: https://pypi.org/project/logdag/
8+
9+
.. image:: https://img.shields.io/pypi/pyversions/logdag
10+
:alt: Python support
11+
:target: https://pypi.org/project/logdag/
12+
13+
.. image:: https://img.shields.io/badge/License-BSD%203--Clause-blue.svg
14+
:alt: BSD 3-Clause License
15+
:target: https://opensource.org/licenses/BSD-3-Clause
16+
17+
.. image:: https://github.com/amulog/logdag/actions/workflows/test.yml/badge.svg?branch=master
18+
:alt: Test
19+
:target: https://github.com/amulog/logdag/actions/workflows/test.yml
20+
21+
.. image:: https://img.shields.io/badge/docs-wiki-blue.svg
22+
:alt: Documentation
23+
:target: https://github.com/amulog/logdag/wiki
24+
25+
526
Overview
627
========
728

@@ -27,7 +48,9 @@ short usage:
2748
4. Generate DAGs by subcommand :code:`makedag`
2849
5. See results by commands such as :code:`show-subgraphs`
2950

30-
See tutorial directory for more information.
51+
See the `wiki <https://github.com/amulog/logdag/wiki>`_ for full documentation
52+
(installation, quick start, configuration, causal-discovery methods, and CLI
53+
reference), and the :code:`tutorial` directory for a runnable sample.
3154

3255
Reference
3356
=========

0 commit comments

Comments
 (0)