Skip to content

Commit 8a99f39

Browse files
committed
update readme and remove docs
1 parent 0ecfa71 commit 8a99f39

6 files changed

Lines changed: 15 additions & 109 deletions

File tree

β€Ž.github/workflows/actions.ymlβ€Ž

Lines changed: 0 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -57,20 +57,6 @@ jobs:
5757
run: |
5858
pytest test --run-slow
5959
60-
docs:
61-
needs: [test, check-style]
62-
if: ${{ github.ref == 'refs/heads/main' }}
63-
runs-on: ubuntu-latest
64-
steps:
65-
- name: Checkout πŸ”–
66-
uses: actions/checkout@v3
67-
- name: Deploy docs
68-
uses: mhausenblas/mkdocs-deploy-gh-pages@master
69-
env:
70-
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
71-
CONFIG_FILE: mkdocs.yml
72-
REQUIREMENTS: requirements-docs.txt
73-
7460
pypi-release:
7561
needs: [test, check-style]
7662
if: ${{ github.event_name == 'push' && startsWith(github.ref, 'refs/tags/v') }}

β€ŽREADME.mdβ€Ž

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,26 @@
1-
<div align="center">
2-
<img src="https://data-as-code.github.io/dac/img/motto.png" width="450"/>
3-
</div>
1+
# `dac`: A CLI Helper Tool for Data as Code
42

5-
# `dac`: Data as Code
3+
[Data as Code](https://data-as-code.github.io/docs/) (DaC) is a paradigm of distributing versioned data as code.
64

7-
Data-as-Code (DaC) `dac` is a tool that supports the distribution of data as (python) code.
8-
9-
<div align="center">
10-
<img src="https://data-as-code.github.io/dac/img/logo.jpg" width="250"/>
11-
</div>
5+
`dac` is a tool that [supports the Producer](https://data-as-code.github.io/docs/#3-use-the-dac-cli-tool).
126

137
**IMPORTANT**: Currently the project is in the initial development phase, this is why releases are marked as `0.z.y`.
148
(following [semantic versioning 2.0.0](https://semver.org/): "Major version zero (0.y.z) is for initial development.
159
Anything MAY change at any time. The public API SHOULD NOT be considered stable.").
1610
While in this phase, we will denote breaking changes with a minor increase.
1711

18-
## πŸ“” [User documentation](https://data-as-code.github.io/dac/)
12+
## Quickstart
13+
14+
You can install `dac` as a regular python package
15+
16+
```sh
17+
python -m pip install dac
18+
```
19+
20+
Then use the integrated help to find out its functionalities
21+
```sh
22+
dac --help
23+
```
1924

2025
## Setup development environment (for contributors only)
2126

β€Ždocs/examples.mdβ€Ž

Lines changed: 0 additions & 5 deletions
This file was deleted.

β€Ždocs/img/logo.jpgβ€Ž

-201 KB
Binary file not shown.

β€Ždocs/img/motto.pngβ€Ž

-44.7 KB
Binary file not shown.

β€Ždocs/index.mdβ€Ž

Lines changed: 0 additions & 80 deletions
This file was deleted.

0 commit comments

Comments
Β (0)