Skip to content

Commit

Permalink
Modify README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Sprocketer authored Apr 10, 2024
1 parent 801a3ac commit 3e7f182
Showing 1 changed file with 3 additions and 4 deletions.
7 changes: 3 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,13 @@ This is a *template repository*, so its intended use is to create other reposito

Set up by default with an **authentication system** - this is suited for general websites, but of course also works for data display apps.


## Dependencies

### Pip Packages

All pip requirements are listed in *`requirements.txt`*

**Make sure you upgrade the Streamlit requirement to the version you develop with**

## Authentication

Expand All @@ -28,7 +28,6 @@ Uses streamlit-authenticator library for authentication widgets

Credentials are stored in *`config.yaml`*


## Config && Secrets

### Config
Expand All @@ -39,16 +38,16 @@ Configuration for Streamlit is stored in *`/.streamlit/config.toml`*

Secrets for Streamlit environment are stored in *`/.streamlit/secrets.toml`*

*Warning: Never hardcode secrets - use GitHub secrets*

## Github Actions

### Pylint

Default Pylint Github Action is set up in *`/.github/workflows/pylint.yml`*


## Licensing

### None (ish).
### None (ish)

Unlicensed using **`https://unlicense.org/`** - see *`UNLICENSE`* file

0 comments on commit 3e7f182

Please sign in to comment.