Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
alicemacl authored Aug 30, 2024
1 parent bf2ad7c commit e2feb43
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Spor

This is the monorepo containing Vy's design system, **Spor**, and its supporting applications.
This is the monorepo containing Vy's design system, **Spor**, and its supporting applications. Scroll to find contribute!

## What's inside?

Expand Down Expand Up @@ -69,6 +69,16 @@ You'll find lots of components, and extensive documentation on the [documentatio

The React Native version of Spor lives in the [app repo](https://github.com/nsbno/salgsapp-react-native/tree/master/app/spor). The APIs should be pretty much the same as in React, but there might be some differences. Look at the relevant documentation for more information.

# CONTRIBUTE

All documentation on how to contribute is available on https://spor.vy.no.

How to make a React component(and change it): https://spor.vy.no/guides/how-to-make-new-react-components

HOW TO MAKE A CHANGESET: https://spor.vy.no/guides/how-to-make-new-react-components#creating-a-pr-and-publish-package

ALL ABOUT CHANGESETS: https://spor.vy.no/guides/releasing-new-versions

## Setup

To develop locally, clone the repository and run `npm install` at the root level.
Expand Down

0 comments on commit e2feb43

Please sign in to comment.