momenaca commited on
Commit
0ea35c9
1 Parent(s): 59d1f62

update README file

Browse files
Files changed (1) hide show
  1. README.md +41 -5
README.md CHANGED
@@ -1,16 +1,52 @@
1
  ---
2
- title: esrsQ&A
3
- emoji: 🐠
4
  colorFrom: red
5
- colorTo: indigo
6
  sdk: gradio
7
  sdk_version: 4.36.1
8
  app_file: app.py
 
9
  pinned: false
10
- license: apache-2.0
11
  hf_oauth: true
 
12
  ---
13
 
14
  # ESRS Q&A
15
 
16
- WIP
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
+ title: EsrsQ&A
3
+ emoji: 🐨
4
  colorFrom: red
5
+ colorTo: green
6
  sdk: gradio
7
  sdk_version: 4.36.1
8
  app_file: app.py
9
+ fullWidth: true
10
  pinned: false
 
11
  hf_oauth: true
12
+ short_description: Ask any questions related to ESRS
13
  ---
14
 
15
  # ESRS Q&A
16
 
17
+ In late 2022, Ekimetrics built ClimateQ&A, a tool to distill expert-level knowledge into easily digestible insights about climate science. For more information, please visit <a href="url" target="_blank">https://climateqa.com/docs/intro/</a>.
18
+
19
+ The European Corporate Sustainability Reporting Directive (CSRD) has entered into force from the 1st of January 2024 onwards. Inspired from ClimateQ&A, we have now built EsrsQ&A, a tool to distill European Sustainability Reporting Standards (ESRS).
20
+
21
+ ## Table of Contents
22
+ - [Installation](#installation)
23
+ - [Usage](#usage)
24
+ - [Contributing](#contributing)
25
+ - [License](#license)
26
+
27
+ ## Installation
28
+ 1. Clone the repository (SSH):
29
+ ```bash
30
+ git clone git@hf.co:spaces/Ekimetrics/esrs-question-answering
31
+ ```
32
+
33
+ 2. Install dependencies:
34
+ ```bash
35
+ poetry install
36
+ ```
37
+
38
+ ## Usage
39
+ To run the project, use the following command:
40
+ ```bash
41
+ python app.py
42
+ ```
43
+
44
+ ## Contributing
45
+ 1. Clone the repository.
46
+ 2. Create a new branch: `git checkout -b feature-name`.
47
+ 3. Make your changes.
48
+ 4. Push your branch: `git push origin feature-name`.
49
+ 5. Create a pull request.
50
+
51
+ ## License
52
+ WIP